Class documentation of Concepts

Loading...
Searching...
No Matches

#include <Eddy2D_H.hh>

Inheritance diagram for hp2D::InputEddy2D_H:
concepts::InputParameter concepts::OutputOperator

Public Member Functions

 InputEddy2D_H (concepts::InOutParameters &input)
 Constructor.
 
virtual std::ostream & letters (std::ostream &os) const
 
virtual std::ostream & arguments (std::ostream &os) const
 Returns argument list as string.
 
virtual std::ostream & description (std::ostream &os) const
 Returns description for help.
 
virtual int input (int opt, const char *optarg)
 
const concepts::Sequence< Real > & omega () const
 Returns set of angular frequencies.
 
const concepts::PiecewiseFormulaBase< Real > * H0 () const
 Returns formula for homogenization.
 
const concepts::PiecewiseFormulaBase< Real2d > * curlH0 () const
 Returns the curl formula for homogenization.
 
const concepts::PiecewiseFormulaBase< Real > * divgradH0 () const
 Returns the curl formula for homogenization.
 
bool interior () const
 Returns true, if there is a embedded area.
 
enum Eddy2D_H::solverType type () const
 Returns solver.
 
bool solving () const
 Returns true, if model should be solved.
 
const InOutParameters parameters () const
 Returns input parameters.
 
InOutParameters & parameters ()
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Protected Attributes

InOutParameters & input_
 Input parameter.
 

Detailed Description

Helps for reading input parameters for single solving of Eddy2D_H.

Parameter:

[-o OMEGA] [-t SOLVERTYPE] [-M]
Author
Kersten Schmidt, 2005

Definition at line 195 of file Eddy2D_H.hh.

Member Function Documentation

◆ arguments()

virtual std::ostream & hp2D::InputEddy2D_H::arguments ( std::ostream &  os) const
virtual

Returns argument list as string.

Implements concepts::InputParameter.

◆ curlH0()

const concepts::PiecewiseFormulaBase< Real2d > * hp2D::InputEddy2D_H::curlH0 ( ) const
inline

Returns the curl formula for homogenization.

Definition at line 217 of file Eddy2D_H.hh.

◆ description()

virtual std::ostream & hp2D::InputEddy2D_H::description ( std::ostream &  os) const
virtual

Returns description for help.

Implements concepts::InputParameter.

◆ divgradH0()

const concepts::PiecewiseFormulaBase< Real > * hp2D::InputEddy2D_H::divgradH0 ( ) const
inline

Returns the curl formula for homogenization.

Definition at line 220 of file Eddy2D_H.hh.

◆ H0()

const concepts::PiecewiseFormulaBase< Real > * hp2D::InputEddy2D_H::H0 ( ) const
inline

Returns formula for homogenization.

Definition at line 215 of file Eddy2D_H.hh.

◆ info()

virtual std::ostream & hp2D::InputEddy2D_H::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

◆ input()

virtual int hp2D::InputEddy2D_H::input ( int  opt,
const char *  optarg 
)
virtual

Process an argument and sets input parameter, if found.

Returns
0 ok, 1 nothing found, 2 error

Implements concepts::InputParameter.

◆ interior()

bool hp2D::InputEddy2D_H::interior ( ) const
inline

Returns true, if there is a embedded area.

Definition at line 223 of file Eddy2D_H.hh.

◆ letters()

virtual std::ostream & hp2D::InputEddy2D_H::letters ( std::ostream &  os) const
virtual

Return letters for the arguments. If parameters are needed ':' is appended for this letter.

Implements concepts::InputParameter.

◆ omega()

const concepts::Sequence< Real > & hp2D::InputEddy2D_H::omega ( ) const
inline

Returns set of angular frequencies.

Definition at line 213 of file Eddy2D_H.hh.

◆ parameters() [1/2]

InOutParameters & concepts::InputParameter::parameters ( )
inlineinherited

Definition at line 46 of file inputParam.hh.

◆ parameters() [2/2]

const InOutParameters concepts::InputParameter::parameters ( ) const
inlineinherited

Returns input parameters.

Definition at line 45 of file inputParam.hh.

◆ solving()

bool hp2D::InputEddy2D_H::solving ( ) const
inline

Returns true, if model should be solved.

Definition at line 227 of file Eddy2D_H.hh.

◆ type()

enum Eddy2D_H::solverType hp2D::InputEddy2D_H::type ( ) const
inline

Returns solver.

Definition at line 225 of file Eddy2D_H.hh.

Member Data Documentation

◆ input_

InOutParameters& concepts::InputParameter::input_
protectedinherited

Input parameter.

Definition at line 50 of file inputParam.hh.


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