concepts::InputEddy2DGeometries Class Reference

Helps for reading input parameters for Eddy2D geometries. More...

#include <Eddy2D_geometries.hh>

Inheritance diagram for concepts::InputEddy2DGeometries:

Collaboration diagram for concepts::InputEddy2DGeometries:

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.
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.
	InputEddy2DGeometries (concepts::InOutParameters &input, const Real sigma=SIGMA_CU, const Real sigma0=0)
	Constructor.
	InputEddy2DGeometries (concepts::InOutParameters &input, const Real sigma=SIGMA_CU, const Real sigma0=0)
	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 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.
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 Eddy2D geometries.

Author:

Kersten Schmidt, 2005

Definition at line 274 of file Eddy2D_geometries.hh.

---

Constructor & Destructor Documentation

concepts::InputEddy2DGeometries::InputEddy2DGeometries	(	concepts::InOutParameters &	input,
		const Real	sigma = SIGMA_CU,
		const Real	sigma0 = 0
	)

Constructor.

Parameters:

input	container for command line arguments
sigma	default value for sigma in conducting region
sigma0	default value for sigma in nonconducting region

concepts::InputEddy2DGeometries::InputEddy2DGeometries	(	concepts::InOutParameters &	input,
		const Real	sigma = SIGMA_CU,
		const Real	sigma0 = 0
	)

Constructor.

Parameters:

input	container for command line arguments
sigma	default value for sigma in conducting region
sigma0	default value for sigma in nonconducting region

---

Member Function Documentation

virtual std::ostream& concepts::InputEddy2DGeometries::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

virtual std::ostream& concepts::InputEddy2DGeometries::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

virtual std::ostream& concepts::InputEddy2DGeometries::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

virtual std::ostream& concepts::InputEddy2DGeometries::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

virtual std::ostream& concepts::InputEddy2DGeometries::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

virtual std::ostream& concepts::InputEddy2DGeometries::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

virtual int concepts::InputEddy2DGeometries::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 concepts::InputEddy2DGeometries::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& concepts::InputEddy2DGeometries::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& concepts::InputEddy2DGeometries::letters

(

std::ostream &

os

)

const [virtual]

Return letters for the arguments.

If parameters are needed ':' is appended for this letter.

Implements concepts::InputParameter.

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.

---

Member Data Documentation

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

Input parameter.

Definition at line 47 of file inputParam.hh.

---

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

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