Templated function that returns a constant value. More...

#include <Constant.H>

Inheritance diagram for Constant< Type >:

[legend]

Collaboration diagram for Constant< Type >:

Public Member Functions
	TypeName ("constant")
void	operator= (const Constant< Type > &)=delete
	No copy assignment.
	Constant (const word &entryName, const Type &value, const objectRegistry *obrPtr=nullptr)
	Construct from components.
	Constant (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry.
	Constant (const word &entryName, Istream &is)
	Construct from entry name and Istream.
	Constant (const Constant< Type > &rhs)
	Copy constructor.
virtual tmp< Function1< Type > >	clone () const
	Return a clone.
virtual	~Constant ()=default
	Destructor.
void	reset (const Type &val)
	Change the constant value.
virtual bool	constant () const
	Value is independent of x.
virtual Type	value (const scalar) const
	Return constant value.
virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values.
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable.
virtual void	writeData (Ostream &os) const
	Write as primitive (inline) format.
const::Foam::word	typeName (Function1Types::Constant< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< label >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< scalar >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< vector >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< sphericalTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< symmTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< tensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Constant< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Constant< scalarField >::typeName_(), 0))
Public Member Functions inherited from Function1< Type >
virtual const word &	type () const
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name.
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry.
	Function1 (const Function1< Type > &rhs)
	Copy construct.
virtual	~Function1 ()=default
	Destructor.
virtual bool	good () const
	Can function be evaluated?
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values.
virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format.
const::Foam::word	typeName (Function1< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0))
Function1< label >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< label >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< label >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0))
Function1< scalar >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalar >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalar >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0))
Function1< vector >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< vector >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< vector >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0))
Function1< sphericalTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< sphericalTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< sphericalTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0))
Function1< symmTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< symmTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< symmTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0))
Function1< tensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< tensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< tensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0))
Function1< scalarField >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalarField >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalarField >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry.
	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry.
	function1Base (const function1Base &rhs)
	Copy construct.
virtual	~function1Base ()
	Destructor.
const word &	name () const noexcept
	The name of the entry.
const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr.
void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry.
void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry.
const objectRegistry &	obr () const
	Return the object registry.
bool	isTime () const noexcept
	Return true if this function was created with the time database.
const Time &	time () const
	Return the time database.
template<class MeshType>
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh.
virtual void	userTimeToTime (const Time &t)
	Convert time.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType
	The return type.
typedef autoPtr< Function1 >(*	dictionaryConstructorPtr) (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr)
	Declare runtime constructor selection table.
typedef ::Foam::HashTable< dictionaryConstructorPtr, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorTableType
typedef ::Foam::HashTable< std::pair<::Foam::word, int >, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorCompatTableType
Static Public Member Functions inherited from Function1< Type >
static const char *	typeName_ ()
	Runtime type information.
static dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
static void	dictionaryConstructorTablePtr_construct (bool load)
static dictionaryConstructorPtr	dictionaryConstructorTable (const ::Foam::word &k)
template<class Derived>
static tmp< Function1< Type > >	Clone (const Derived &fun)
	Clone a Function1.
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.
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.
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
	An optional selector, with fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	An optional selector, without fallback redirection.
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)
	Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
Static Public Attributes inherited from Function1< Type >
static const ::Foam::word	typeName
static int	debug
static dictionaryConstructorTableType *	dictionaryConstructorTablePtr_
static std::unique_ptr< dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_
Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment.
Protected Attributes inherited from function1Base
const word	name_
	Name of entry.
const objectRegistry *	obrPtr_
	Pointer to an object registry.

Detailed Description

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

Templated function that returns a constant value.

Usage - for entry <entryName> returning the value <value>, can be specified is different formats.

Inline specification:

    <entryName>  constant <value>

Dictionary format:

    <entryName>
    {
        type    constant;
        value   <value>;
    }

Source files

Definition at line 68 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

template<class Type>

Constant	(	const word &	entryName,
		const Type &	value,
		const objectRegistry *	obrPtr = nullptr )

Construct from components.

Definition at line 27 of file Constant.C.

References Function1< Type >::Function1(), and value().

Referenced by Constant(), debug(), operator=(), and Uniform< Type >::Uniform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Constant() [2/4]

template<class Type>

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

Construct from entry name, dictionary and optional registry.

Definition at line 40 of file Constant.C.

References dict, Function1< Type >::Function1(), entry::isStream(), keyType::LITERAL, and Foam::Zero.

Here is the call graph for this function:

◆ Constant() [3/4]

template<class Type>

Constant	(	const word &	entryName,
		Istream &	is )

Construct from entry name and Istream.

Reads the constant value without the Function1 type for backward compatibility

Definition at line 77 of file Constant.C.

References Function1< Type >::Function1().

Here is the call graph for this function:

◆ Constant() [4/4]

template<class Type>

Constant ( const Constant< Type > & rhs )

explicit

Copy constructor.

Definition at line 89 of file Constant.C.

References Constant(), Function1< Type >::Function1(), and Foam::rhs().

Here is the call graph for this function:

◆ ~Constant()

template<class Type>

virtual ~Constant ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "constant" )

◆ operator=()

template<class Type>

void operator= ( const Constant< Type > & )

delete

No copy assignment.

References Constant(), dict, Foam::rhs(), and value().

Here is the call graph for this function:

◆ clone()

template<class Type>

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

inlinevirtual

Return a clone.

Implements Function1< Type >.

Reimplemented in Uniform< Type >.

Definition at line 132 of file Constant.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

◆ reset()

template<class Type>

void reset ( const Type & val )

inline

Change the constant value.

Definition at line 27 of file ConstantI.H.

◆ constant()

template<class Type>

virtual bool constant ( ) const

inlinevirtual

Value is independent of x.

Reimplemented from Function1< Type >.

Definition at line 154 of file Constant.H.

◆ value() [1/2]

template<class Type>

Type value ( const scalar ) const

inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 34 of file ConstantI.H.

Referenced by Constant(), and operator=().

Here is the caller graph for this function:

◆ integrate()

template<class Type>

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

inlinevirtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 41 of file ConstantI.H.

◆ value() [2/2]

template<class Type>

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 99 of file Constant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ writeData()

template<class Type>

void writeData ( Ostream & os ) const

virtual

Write as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 109 of file Constant.C.

References os(), token::SPACE, and Function1< Type >::writeData().

Here is the call graph for this function:

◆ typeName() [1/7]

const::Foam::word typeName ( Function1Types::Constant< label > ::typeName_() )

◆ debug() [1/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< label >::typeName_(), 0) )

References Constant().

Here is the call graph for this function:

◆ typeName() [2/7]

const::Foam::word typeName ( Function1Types::Constant< scalar > ::typeName_() )

◆ debug() [2/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< scalar >::typeName_(), 0) )

◆ typeName() [3/7]

const::Foam::word typeName ( Function1Types::Constant< vector > ::typeName_() )

◆ debug() [3/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< vector >::typeName_(), 0) )

◆ typeName() [4/7]

const::Foam::word typeName ( Function1Types::Constant< sphericalTensor > ::typeName_() )

◆ debug() [4/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< sphericalTensor >::typeName_(), 0) )

◆ typeName() [5/7]

const::Foam::word typeName ( Function1Types::Constant< symmTensor > ::typeName_() )

◆ debug() [5/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< symmTensor >::typeName_(), 0) )

◆ typeName() [6/7]

const::Foam::word typeName ( Function1Types::Constant< tensor > ::typeName_() )

◆ debug() [6/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< tensor >::typeName_(), 0) )

◆ typeName() [7/7]

const::Foam::word typeName ( Function1Types::Constant< scalarField > ::typeName_() )

◆ debug() [7/7]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Constant< scalarField >::typeName_(), 0) )

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

src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H
src/OpenFOAM/primitives/functions/Function1/Constant/Constant.C
src/OpenFOAM/primitives/functions/Function1/Constant/ConstantI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Constant() [1/4]

◆ Constant() [2/4]

◆ Constant() [3/4]

◆ Constant() [4/4]

◆ ~Constant()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ reset()

◆ constant()

◆ value() [1/2]

◆ integrate()

◆ value() [2/2]

◆ writeData()

◆ typeName() [1/7]

◆ debug() [1/7]

◆ typeName() [2/7]

◆ debug() [2/7]

◆ typeName() [3/7]

◆ debug() [3/7]

◆ typeName() [4/7]

◆ debug() [4/7]

◆ typeName() [5/7]

◆ debug() [5/7]

◆ typeName() [6/7]

◆ debug() [6/7]

◆ typeName() [7/7]

◆ debug() [7/7]