Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim > Class Template Reference

#include <time_harmonic_maxwell_boundary_conditions.h>

Inheritance diagram for BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >:
[legend]

Public Member Functions

void declare_default_entry (ParameterHandler &prm, types::boundary_id default_boundary_id)
void declare_parameters (ParameterHandler &prm, unsigned int number_of_boundary_conditions)
void parse_boundary (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

std::map< types::boundary_id, std::shared_ptr< TimeHarmonicMaxwellBoundaryFunctions< dim > > > imposed_electromagnetic_fields
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > surface_admittance_real
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > surface_admittance_imag
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_x_real
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_y_real
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_z_real
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_x_imag
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_y_imag
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > excitation_z_imag
Public Attributes inherited from BoundaryConditions::BoundaryConditions< TimeHarmonicMaxwellBoundaryType >
std::map< types::boundary_id, TimeHarmonicMaxwellBoundaryType > type
unsigned int number_of_boundary_conditions
bool time_dependent
Parameters::PeriodicBoundaries periodic_boundaries

Detailed Description

template<int dim>
class BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >

This class manages the boundary conditions for Time Harmonic Maxwell solver. It introduces the boundary functions and declares the boundary conditions coherently.

Definition at line 77 of file time_harmonic_maxwell_boundary_conditions.h.

Member Function Documentation

◆ declare_default_entry()

◆ declare_parameters()

template<int dim>
void BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::declare_parameters ( ParameterHandler & prm,
unsigned int number_of_boundary_conditions )

Declare the Time Harmonic Maxwell boundary conditions.

Parameters
[in,out]prmThe parameter handler object.
[in]number_of_boundary_conditionsThe number of boundary conditions to declare.

Definition at line 133 of file time_harmonic_maxwell_boundary_conditions.cc.

References declare_default_entry(), and BoundaryConditions::BoundaryConditions< TimeHarmonicMaxwellBoundaryType >::number_of_boundary_conditions.

◆ parse_boundary()

template<int dim>
void BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::parse_boundary ( ParameterHandler & prm)

Parse the information for one time-harmonic Maxwell boundary condition.

Parameters
[in]prmThe parameter handler object.

The following functions are parsed individually because they will be used for Robin boundary conditions and will not be applied on the global solution vector.

Definition at line 163 of file time_harmonic_maxwell_boundary_conditions.cc.

References convert_string_to_vector(), BoundaryConditions::deprecated_time_harmonic_maxwell_boundary_type_names, excitation_x_imag, excitation_x_real, excitation_y_imag, excitation_y_real, excitation_z_imag, excitation_z_real, imposed_electromagnetic_fields, string_to_enum(), surface_admittance_imag, surface_admittance_real, and BoundaryConditions::BoundaryConditions< TimeHarmonicMaxwellBoundaryType >::type.

◆ parse_parameters()

template<int dim>
void BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::parse_parameters ( ParameterHandler & prm)

Parse the Time Harmonic Maxwell boundary conditions.

Parameters
[in]prmThe parameter handler containing the boundary conditions.

Definition at line 310 of file time_harmonic_maxwell_boundary_conditions.cc.

References BoundaryConditions::BoundaryConditions< TimeHarmonicMaxwellBoundaryType >::number_of_boundary_conditions, parse_boundary(), and BoundaryConditions::BoundaryConditions< TimeHarmonicMaxwellBoundaryType >::time_dependent.

Member Data Documentation

◆ excitation_x_imag

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_x_imag

Definition at line 113 of file time_harmonic_maxwell_boundary_conditions.h.

◆ excitation_x_real

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_x_real

Excitation.

Definition at line 104 of file time_harmonic_maxwell_boundary_conditions.h.

◆ excitation_y_imag

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_y_imag

Definition at line 116 of file time_harmonic_maxwell_boundary_conditions.h.

◆ excitation_y_real

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_y_real

Definition at line 107 of file time_harmonic_maxwell_boundary_conditions.h.

◆ excitation_z_imag

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_z_imag

Definition at line 119 of file time_harmonic_maxwell_boundary_conditions.h.

◆ excitation_z_real

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::excitation_z_real

Definition at line 110 of file time_harmonic_maxwell_boundary_conditions.h.

◆ imposed_electromagnetic_fields

template<int dim>
std::map<types::boundary_id, std::shared_ptr<TimeHarmonicMaxwellBoundaryFunctions<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::imposed_electromagnetic_fields

Functions for (e_x_real, e_y_real, e_z_real, e_x_imag, e_y_imag, e_z_imag, h_x_real, h_y_real, h_z_real, h_x_imag, h_y_imag, h_z_imag)

Definition at line 85 of file time_harmonic_maxwell_boundary_conditions.h.

◆ surface_admittance_imag

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::surface_admittance_imag

Definition at line 99 of file time_harmonic_maxwell_boundary_conditions.h.

◆ surface_admittance_real

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TimeHarmonicMaxwellBoundaryConditions< dim >::surface_admittance_real

The following functions are associated with both imperfect conductor and imposed electromagnetic excitation or absorption boundary conditions of the Time Harmonic Maxwell equations, but are parsed individually because they will not be applied to the vector solution and will therefore be handled manually in the solver.

Definition at line 96 of file time_harmonic_maxwell_boundary_conditions.h.


The documentation for this class was generated from the following files: