hp2D::InputMaxwell2D_H Class Reference

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

#include <Maxwell2D_H.hh>

Inheritance diagram for hp2D::InputMaxwell2D_H:

Collaboration diagram for hp2D::InputMaxwell2D_H:

List of all members.

Public Member Functions
virtual std::ostream &	arguments (std::ostream &os) const
	Returns argument list as string.
virtual std::ostream &	arguments (std::ostream &os) const
	Returns argument list as string.
enum concepts::MaxwellBoundary::boundaryType	boundary () const
	Returns type of boundary condition.
virtual std::ostream &	description (std::ostream &os) const
	Returns description for help.
virtual std::ostream &	description (std::ostream &os) const
	Returns description for help.
virtual int	input (int opt, const char *optarg)
	Process an argument and sets input parameter, if found.
virtual int	input (int opt, const char *optarg)
	Process an argument and sets input parameter, if found.
	InputMaxwell2D_H (concepts::InOutParameters &input)
	Constructor.
	InputMaxwell2D_H (concepts::InOutParameters &input)
	Constructor.
virtual std::ostream &	letters (std::ostream &os) const
	Return letters for the arguments.
virtual std::ostream &	letters (std::ostream &os) const
	Return letters for the arguments.
const concepts::Sequence< Real > &	omega () const
	Returns set of angular frequencies.
InOutParameters &	parameters ()
const InOutParameters	parameters () const
	Returns input parameters.
bool	solving () const
	Returns true, if model should be solved.
bool	solving () const
	Returns true, if model should be solved.
enum Maxwell2D_H::solverType	type () const
	Returns solver.
enum Maxwell2D_H::solverType	type () const
	Returns solver.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Protected Attributes
InOutParameters &	input_
	Input parameter.
Private Attributes
enum concepts::MaxwellBoundary::boundaryType	bType_
	Boundary condition.
bool	defaultOmega_
	Flag, if no omega is given.
concepts::Sequence< Real >	omega_
	Set of angular frequencies.
bool	solving_
	True, if model should be solved.
enum Maxwell2D_H::solverType	type_
	Solver type.

---

Detailed Description

Helps for reading input parameters for single solving of Maxwell2D_H.

Helps for reading input parameters for single solving of Maxwell2D_H_Base.

Author:

Kersten Schmidt, 2005

Parameter:

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

Author:

Kersten Schmidt, 2005

Definition at line 131 of file Maxwell2D_H.hh.

---

Constructor & Destructor Documentation

hp2D::InputMaxwell2D_H::InputMaxwell2D_H

(

concepts::InOutParameters &

input

)

Constructor.

hp2D::InputMaxwell2D_H::InputMaxwell2D_H

(

concepts::InOutParameters &

input

)

Constructor.

---

Member Function Documentation

virtual std::ostream& hp2D::InputMaxwell2D_H::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

virtual std::ostream& hp2D::InputMaxwell2D_H::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

enum concepts::MaxwellBoundary::boundaryType hp2D::InputMaxwell2D_H::boundary

(

)

const [inline]

Returns type of boundary condition.

Definition at line 279 of file Maxwell2D_H.hh.

virtual std::ostream& hp2D::InputMaxwell2D_H::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

virtual std::ostream& hp2D::InputMaxwell2D_H::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

virtual std::ostream& hp2D::InputMaxwell2D_H::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

virtual std::ostream& hp2D::InputMaxwell2D_H::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

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.

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.

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.

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.

const concepts::Sequence<Real>& hp2D::InputMaxwell2D_H::omega

(

)

const [inline]

Returns set of angular frequencies.

Definition at line 275 of file Maxwell2D_H.hh.

InOutParameters& concepts::InputParameter::parameters

(

)

[inline, inherited]

Definition at line 43 of file inputParam.hh.

const InOutParameters concepts::InputParameter::parameters

(

)

const [inline, inherited]

Returns input parameters.

Definition at line 42 of file inputParam.hh.

bool hp2D::InputMaxwell2D_H::solving

(

)

const [inline]

Returns true, if model should be solved.

Definition at line 283 of file Maxwell2D_H.hh.

bool hp2D::InputMaxwell2D_H::solving

(

)

const [inline]

Returns true, if model should be solved.

Definition at line 151 of file Maxwell2D_H.hh.

enum Maxwell2D_H::solverType hp2D::InputMaxwell2D_H::type

(

)

const [inline]

Returns solver.

Definition at line 149 of file Maxwell2D_H.hh.

enum Maxwell2D_H::solverType hp2D::InputMaxwell2D_H::type

(

)

const [inline]

Returns solver.

Definition at line 277 of file Maxwell2D_H.hh.

---

Member Data Documentation

enum concepts::MaxwellBoundary::boundaryType hp2D::InputMaxwell2D_H::bType_ [private]

Boundary condition.

Definition at line 288 of file Maxwell2D_H.hh.

bool hp2D::InputMaxwell2D_H::defaultOmega_ [private]

Flag, if no omega is given.

Definition at line 292 of file Maxwell2D_H.hh.

InOutParameters& concepts::InputParameter::input_ [protected, inherited]

Input parameter.

Definition at line 47 of file inputParam.hh.

concepts::Sequence<Real> hp2D::InputMaxwell2D_H::omega_ [private]

Set of angular frequencies.

Definition at line 290 of file Maxwell2D_H.hh.

bool hp2D::InputMaxwell2D_H::solving_ [private]

True, if model should be solved.

Definition at line 157 of file Maxwell2D_H.hh.

enum Maxwell2D_H::solverType hp2D::InputMaxwell2D_H::type_ [private]

Solver type.

Definition at line 155 of file Maxwell2D_H.hh.

---

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

• app-kersten/Maxwell2D_H.hh
• models/Maxwell2D_H.hh