hp2D::InputMaxwell2D_H Class Reference

Helps for reading input parameters for single solving of Maxwell2D_H_Base. More...

#include <Maxwell2D_H.hh>

Inheritance diagram for hp2D::InputMaxwell2D_H:

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_H (concepts::InOutParameters &input)
	Constructor. More...
virtual std::ostream &	letters (std::ostream &os) const
	Return letters for the arguments. More...
const concepts::Sequence< Real > &	omega () const
	Returns set of angular frequencies. More...
InOutParameters &	parameters ()
const InOutParameters	parameters () const
	Returns input parameters. More...
bool	solving () const
	Returns true, if model should be solved. More...
enum Maxwell2D_H::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	defaultOmega_
	Flag, if no omega is given. More...
concepts::Sequence< Real >	omega_
	Set of angular frequencies. More...
bool	solving_
	True, if model should be solved. More...
enum Maxwell2D_H::solverType	type_
	Solver type. More...

Detailed Description

Helps for reading input parameters for single solving of Maxwell2D_H_Base.

Parameter:

[-e EPSILON] [-o OMEGA] [-b BOUNDARY] [-t SOLVERTYPE] [-D] [-a] [-M]

Author

Kersten Schmidt, 2005

Definition at line 257 of file Maxwell2D_H.hh.

Constructor & Destructor Documentation

InputMaxwell2D_H()

hp2D::InputMaxwell2D_H::InputMaxwell2D_H

(

concepts::InOutParameters &

input

)

Constructor.

Member Function Documentation

arguments()

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

virtual

Returns argument list as string.

Implements concepts::InputParameter.

boundary()

enum concepts::MaxwellBoundary::boundaryType hp2D::InputMaxwell2D_H::boundary ( ) const

inline

Returns type of boundary condition.

Definition at line 275 of file Maxwell2D_H.hh.

description()

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

virtual

Returns description for help.

Implements concepts::InputParameter.

info()

virtual std::ostream& hp2D::InputMaxwell2D_H::info ( std::ostream &  os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

input()

virtual int hp2D::InputMaxwell2D_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.

letters()

virtual std::ostream& hp2D::InputMaxwell2D_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::InputMaxwell2D_H::omega ( ) const

inline

Returns set of angular frequencies.

Definition at line 275 of file Maxwell2D_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::InputMaxwell2D_H::solving ( ) const

inline

Returns true, if model should be solved.

Definition at line 283 of file Maxwell2D_H.hh.

type()

enum Maxwell2D_H::solverType hp2D::InputMaxwell2D_H::type ( ) const

inline

Returns solver.

Definition at line 275 of file Maxwell2D_H.hh.

Member Data Documentation

bType_

enum concepts::MaxwellBoundary::boundaryType hp2D::InputMaxwell2D_H::bType_

private

Boundary condition.

Definition at line 285 of file Maxwell2D_H.hh.

defaultOmega_

bool hp2D::InputMaxwell2D_H::defaultOmega_

private

Flag, if no omega is given.

Definition at line 292 of file Maxwell2D_H.hh.

input_

InOutParameters& concepts::InputParameter::input_

protectedinherited

Input parameter.

Definition at line 50 of file inputParam.hh.

omega_

concepts::Sequence<Real> hp2D::InputMaxwell2D_H::omega_

private

Set of angular frequencies.

Definition at line 290 of file Maxwell2D_H.hh.

solving_

bool hp2D::InputMaxwell2D_H::solving_

private

True, if model should be solved.

Definition at line 296 of file Maxwell2D_H.hh.

type_

enum Maxwell2D_H::solverType hp2D::InputMaxwell2D_H::type_

private

Solver type.

Definition at line 292 of file Maxwell2D_H.hh.

---

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

• models/Maxwell2D_H.hh