concepts::InputEddy2DGeometries Class Reference

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

#include <Eddy2D_geometries.hh>

Inheritance diagram for concepts::InputEddy2DGeometries:

Public Member Functions
virtual std::ostream &	arguments (std::ostream &os) const
	Returns argument list as string. 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...
	InputEddy2DGeometries (concepts::InOutParameters &input, const Real sigma=SIGMA_CU, const Real sigma0=0)
	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...

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...

Detailed Description

Helps for reading input parameters for Eddy2D geometries.

Author

Kersten Schmidt, 2005

Definition at line 277 of file Eddy2D_geometries.hh.

Constructor & Destructor Documentation

InputEddy2DGeometries()

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

arguments()

virtual std::ostream& concepts::InputEddy2DGeometries::arguments ( std::ostream &  os ) const

virtual

Returns argument list as string.

Implements concepts::InputParameter.

description()

virtual std::ostream& concepts::InputEddy2DGeometries::description ( std::ostream &  os ) const

virtual

Returns description for help.

Implements concepts::InputParameter.

info()

virtual std::ostream& concepts::InputEddy2DGeometries::info ( std::ostream &  os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

input()

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.

letters()

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.

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.

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:

• models/Eddy2D_geometries.hh