CompatibilityConstant Class Reference

Templated basic entry that holds a constant value for backwards compatibility (when DataEntry type is not present) More...

Collaboration diagram for CompatibilityConstant:

Public Member Functions
	TypeName ("CompatibilityConstant")
	CompatibilityConstant (const word &entryName, const dictionary &dict)
	Construct from entry name and Istream. More...
	CompatibilityConstant (const CompatibilityConstant< Type > &cnst)
	Copy constructor. More...
virtual tmp< DataEntry< Type > >	clone () const
	Construct and return a clone. More...
virtual	~CompatibilityConstant ()
	Destructor. More...
Type	value (const scalar) const
	Return constant value. More...
Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values. More...
dimensioned< Type >	dimValue (const scalar) const
	Return dimensioned constant value. More...
dimensioned< Type >	dimIntegrate (const scalar x1, const scalar x2) const
	Integrate between two values and return dimensioned type. More...
virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

Private Member Functions
void	operator= (const CompatibilityConstant< Type > &)
	Disallow default bitwise assignment. More...

Private Attributes
Type	value_
	Constant value. More...
dimensionSet	dimensions_
	The dimension set. More...

Friends
Ostream &	operator (Ostream &os, const CompatibilityConstant< Type > &cnst)
	Ostream Operator. More...

Detailed Description

Templated basic entry that holds a constant value for backwards compatibility (when DataEntry type is not present)

Usage - for entry <entryName> having the value

:

    <entryName>    <value>

Source files

• CompatibilityConstant.H
• CompatibilityConstant.C

Definition at line 52 of file CompatibilityConstant.H.

Constructor & Destructor Documentation

CompatibilityConstant() [1/2]

CompatibilityConstant	(	const word &	entryName,
		const dictionary &	dict
	)

Construct from entry name and Istream.

Definition at line 32 of file CompatibilityConstant.C.

References dict, token::isWord(), and Istream::putBack().

Here is the call graph for this function:

CompatibilityConstant() [2/2]

CompatibilityConstant

(

const CompatibilityConstant< Type > &

cnst

)

Copy constructor.

Definition at line 64 of file CompatibilityConstant.C.

~CompatibilityConstant()

~CompatibilityConstant ( )

virtual

Destructor.

Definition at line 77 of file CompatibilityConstant.C.

Member Function Documentation

operator=()

void operator= ( const CompatibilityConstant< Type > &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"CompatibilityConstant"

)

clone()

virtual tmp<DataEntry<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 96 of file CompatibilityConstant.H.

value()

Type value

(

const scalar

x

)

const

Return constant value.

Definition at line 84 of file CompatibilityConstant.C.

integrate()

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const

Integrate between two values.

Definition at line 92 of file CompatibilityConstant.C.

dimValue()

Foam::dimensioned< Type > dimValue

(

const scalar

x

)

const

Return dimensioned constant value.

Definition at line 103 of file CompatibilityConstant.C.

dimIntegrate()

Foam::dimensioned< Type > dimIntegrate	(	const scalar	x1,
		const scalar	x2
	)		const

Integrate between two values and return dimensioned type.

Definition at line 111 of file CompatibilityConstant.C.

writeData()

void writeData ( Ostream &  os ) const

virtual

Write in dictionary format.

Definition at line 63 of file CompatibilityConstantIO.C.

References Foam::nl, and Ostream::writeKeyword().

Here is the call graph for this function:

Friends And Related Function Documentation

operator

Ostream& operator ( Ostream &  os, const CompatibilityConstant< Type > &  cnst  )

friend

Ostream Operator.

Field Documentation

value_

Type value_

private

Constant value.

Definition at line 69 of file CompatibilityConstant.H.

dimensions_

dimensionSet dimensions_

private

The dimension set.

Definition at line 72 of file CompatibilityConstant.H.

---

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

• src/OpenFOAM/primitives/functions/DataEntry/CompatibilityConstant/CompatibilityConstant.H
• src/OpenFOAM/primitives/functions/DataEntry/CompatibilityConstant/CompatibilityConstant.C
• src/OpenFOAM/primitives/functions/DataEntry/CompatibilityConstant/CompatibilityConstantIO.C