Templated function that returns the corresponding 1 (one). More...

Inheritance diagram for OneConstant< Type >:

Collaboration diagram for OneConstant< Type >:

Public Member Functions
	TypeName ("one")
	Runtime type information. More...

void	operator= (const OneConstant< Type > &)=delete
	No copy assignment. More...

	OneConstant (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry. More...

	OneConstant (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

virtual	~OneConstant ()=default
	Destructor. More...

virtual bool	constant () const
	Value is independent of x. More...

virtual Type	value (const scalar) const
	Return constant value. More...

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable. More...

virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...

virtual void	writeData (Ostream &os) const
	Write as primitive (inline) format. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

virtual	~Function1 ()=default
	Destructor. More...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char , int >> compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Detailed Description

template<class Type>
class Foam::Function1Types::OneConstant< Type >

Templated function that returns the corresponding 1 (one).

Usage:

    <entryName> one;

Source files

Definition at line 59 of file OneConstant.H.

Constructor & Destructor Documentation

◆ OneConstant() [1/2]

OneConstant	(	const word &	entryName,
		const objectRegistry *	obrPtr = `nullptr`
	)

explicit

Construct from entry name and optional registry.

Definition at line 35 of file OneConstant.C.

◆ OneConstant() [2/2]

OneConstant	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 46 of file OneConstant.C.

◆ ~OneConstant()

virtual ~OneConstant ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "one" )

Runtime type information.

◆ operator=()

void operator= ( const OneConstant< Type > & )

delete

No copy assignment.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 93 of file OneConstant.H.

◆ constant()

virtual bool constant ( ) const

inlinevirtual

Value is independent of x.

Reimplemented from Function1< Type >.

Definition at line 106 of file OneConstant.H.

◆ value() [1/2]

Type value ( const scalar x ) const

inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 33 of file OneConstantI.H.

◆ integrate() [1/2]

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

inlinevirtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 41 of file OneConstantI.H.

◆ value() [2/2]

Foam::tmp< Foam::Field< Type > > value ( const scalarField & x ) const

virtual

Return value as a function of (scalar) independent variable.

Reimplemented from Function1< Type >.

Definition at line 60 of file OneConstant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ integrate() [2/2]

Foam::tmp< Foam::Field< Type > > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 70 of file OneConstant.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 80 of file OneConstant.C.

References os(), and writeData().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/One/OneConstant.H
src/OpenFOAM/primitives/functions/Function1/One/OneConstant.C
src/OpenFOAM/primitives/functions/Function1/One/OneConstantI.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::Function1Types::OneConstant< Type >

Constructor & Destructor Documentation

◆ OneConstant() [1/2]

◆ OneConstant() [2/2]

◆ ~OneConstant()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ constant()

◆ value() [1/2]

◆ integrate() [1/2]

◆ value() [2/2]

◆ integrate() [2/2]

◆ writeData()

template<class Type>
class Foam::Function1Types::OneConstant< Type >