hp2D::InputMaxwell2D_E Class Reference
Helps for reading input parameters for single solving of Maxwell2D_E. More...
#include <Maxwell2D_E.hh>
Public Member Functions | |
| virtual std::ostream & | arguments (std::ostream &os) const |
| Returns argument list as string. More... | |
| enum concepts::MaxwellBoundary::boundaryType | boundary () const |
| Returns type of boundary condition. More... | |
| virtual std::ostream & | description (std::ostream &os) const |
| Returns description for help. More... | |
| virtual int | input (int opt, const char *optarg) |
| Process an argument and sets input parameter, if found. More... | |
| InputMaxwell2D_E (concepts::InOutParameters &input) | |
| Constructor. More... | |
| virtual std::ostream & | letters (std::ostream &os) const |
| Return letters for the arguments. More... | |
| InOutParameters & | parameters () |
| const InOutParameters | parameters () const |
| Returns input parameters. More... | |
| bool | solving () const |
| Returns true, if model should be solved. More... | |
| enum Maxwell2D_E::solverType | type () const |
| Returns solver. More... | |
Protected Member Functions | |
| virtual std::ostream & | info (std::ostream &os) const |
| Returns information in an output stream. More... | |
Protected Attributes | |
| InOutParameters & | input_ |
| Input parameter. More... | |
Private Attributes | |
| enum concepts::MaxwellBoundary::boundaryType | bType_ |
| Boundary condition. More... | |
| bool | solving_ |
| True, if model should be solved. More... | |
| enum Maxwell2D_E::solverType | type_ |
| Solver type. More... | |
Detailed Description
Helps for reading input parameters for single solving of Maxwell2D_E.
Definition at line 116 of file Maxwell2D_E.hh.
Constructor & Destructor Documentation
◆ InputMaxwell2D_E()
| hp2D::InputMaxwell2D_E::InputMaxwell2D_E | ( | concepts::InOutParameters & | input | ) |
Constructor.
Member Function Documentation
◆ arguments()
|
virtual |
Returns argument list as string.
Implements concepts::InputParameter.
◆ boundary()
|
inline |
Returns type of boundary condition.
Definition at line 132 of file Maxwell2D_E.hh.
◆ description()
|
virtual |
Returns description for help.
Implements concepts::InputParameter.
◆ info()
|
protectedvirtual |
Returns information in an output stream.
Reimplemented from concepts::InputParameter.
◆ input()
|
virtual |
Process an argument and sets input parameter, if found.
- Returns
- 0 ok, 1 nothing found, 2 error
Implements concepts::InputParameter.
◆ letters()
|
virtual |
Return letters for the arguments.
If parameters are needed ':' is appended for this letter.
Implements concepts::InputParameter.
◆ parameters() [1/2]
|
inlineinherited |
Definition at line 46 of file inputParam.hh.
◆ parameters() [2/2]
|
inlineinherited |
Returns input parameters.
Definition at line 45 of file inputParam.hh.
◆ solving()
|
inline |
Returns true, if model should be solved.
Definition at line 140 of file Maxwell2D_E.hh.
◆ type()
|
inline |
Returns solver.
Definition at line 132 of file Maxwell2D_E.hh.
Member Data Documentation
◆ bType_
|
private |
Boundary condition.
Definition at line 142 of file Maxwell2D_E.hh.
◆ input_
|
protectedinherited |
Input parameter.
Definition at line 50 of file inputParam.hh.
◆ solving_
|
private |
True, if model should be solved.
Definition at line 149 of file Maxwell2D_E.hh.
◆ type_
|
private |
Solver type.
Definition at line 142 of file Maxwell2D_E.hh.
The documentation for this class was generated from the following file:
- models/Maxwell2D_E.hh