Constant< Type > Class Template Reference

Templated basic entry that holds a constant value. More...

#include <lagrangianIntermediate/Constant.H>

---

Detailed Description

template<class Type>
class Foam::Constant< Type >

Templated basic entry that holds a constant value.

Usage - for entry <entryName> having the value

:

<entryName>constant  <value>

Source files

• src/lagrangian/intermediate/submodels/IO/DataEntry/Constant/Constant.H
• src/lagrangian/intermediate/submodels/IO/DataEntry/Constant/Constant.C

Definition at line 65 of file Constant.H.

Inheritance diagram for Constant< Type >:

Collaboration diagram for Constant< Type >:

List of all members.

Public Member Functions
	TypeName ("constant")
	Constant (const word &entryName, Istream &is)
	Construct from entry name and Istream.
	Constant (const Constant< Type > &cnst)
	Copy constructor.
virtual	~Constant ()
	Destructor.
Type	value (const scalar) const
	Return constant value.
Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values.
template<>
	Constant (const word &entryName, Istream &is)
template<>
	Constant (const word &entryName, Istream &is)
template<>
	Constant (const word &entryName, Istream &is)
template<>
	Constant (const word &entryName, Istream &is)
Friends
Ostream &	operator (Ostream &, const Constant< Type > &)
	Ostream Operator.

---

Constructor & Destructor Documentation

Constant	(	const word &	entryName,
		Istream &	is
	)

Construct from entry name and Istream.

Definition at line 31 of file Constant.C.

Constant

(

const Constant< Type > &

cnst  )

Copy constructor.

Definition at line 39 of file Constant.C.

~Constant

(

)

[virtual]

Destructor.

Definition at line 65 of file Constant.C.

Constant	(	const word &	entryName,
		Istream &	is
	)

Definition at line 47 of file Constant.C.

Constant	(	const word &	entryName,
		Istream &	is
	)

Definition at line 55 of file Constant.C.

Constant	(	const word &	entryName,
		Istream &	is
	)

Constant	(	const word &	entryName,
		Istream &	is
	)

---

Member Function Documentation

TypeName

(

"constant"

)

Type value

(

const scalar

x  )

const [virtual]

Return constant value.

Implements DataEntry< Type >.

Definition at line 72 of file Constant.C.

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const [virtual]

Integrate between two values.

Implements DataEntry< Type >.

Definition at line 79 of file Constant.C.

---

Friends And Related Function Documentation

Ostream& operator	(	Ostream &	,
		const Constant< Type > &
	)		[friend]

Ostream Operator.

---

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

• src/lagrangian/intermediate/submodels/IO/DataEntry/Constant/Constant.H
• src/lagrangian/intermediate/submodels/IO/DataEntry/Constant/Constant.C