Templated function that returns a constant value. More...
Public Member Functions | |
TypeName ("constant") | |
void | operator= (const Constant< Type > &)=delete |
No copy assignment. More... | |
Constant (const word &entryName, const Type &value, const objectRegistry *obrPtr=nullptr) | |
Construct from components. More... | |
Constant (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, dictionary and optional registry. More... | |
Constant (const word &entryName, Istream &is) | |
Construct from entry name and Istream. More... | |
Constant (const Constant< Type > &rhs) | |
Copy constructor. More... | |
virtual tmp< Function1< Type > > | clone () const |
Construct and return a clone. More... | |
virtual | ~Constant ()=default |
Destructor. More... | |
void | reset (const Type &val) |
Change the constant value. 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 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) | |
Construct from entry name, (unused) dictionary and optional registry. More... | |
Function1 (const Function1< Type > &rhs) | |
Copy construct. More... | |
virtual | ~Function1 ()=default |
Destructor. More... | |
virtual bool | good () const |
Can function be evaluated? More... | |
virtual tmp< Field< Type > > | integrate (const scalarField &x1, const scalarField &x2) const |
Integrate between two (scalar) values. More... | |
virtual void | writeEntries (Ostream &os) const |
Write coefficient entries in dictionary format. More... | |
Public Member Functions inherited from function1Base | |
function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name and optional registry. More... | |
function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, dictionary (unused) and optional registry. More... | |
function1Base (const function1Base &rhs) | |
Copy construct. More... | |
virtual | ~function1Base () |
Destructor. More... | |
const word & | name () const noexcept |
The name of the entry. More... | |
const objectRegistry * | whichDb () const noexcept |
Return the associated registry or nullptr. More... | |
void | resetDb (const objectRegistry *obrPtr=nullptr) noexcept |
Reset the associated objectRegistry. More... | |
void | resetDb (const objectRegistry &db) noexcept |
Reset the associated objectRegistry. More... | |
const objectRegistry & | obr () const |
Return the object registry. More... | |
bool | isTime () const noexcept |
Return true if this function was created with the time database. More... | |
const Time & | time () const |
Return the time database. More... | |
template<class MeshType > | |
const MeshType & | mesh (const word ®ionName=word::null) const |
Return the mesh database if this Function1 was created using a mesh. More... | |
virtual void | userTimeToTime (const Time &t) |
Convert time. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | use_count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Additional Inherited Members | |
Public Types inherited from Function1< Type > | |
typedef Type | returnType |
The return type. More... | |
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, const objectRegistry *obrPtr=nullptr) |
An optional selector, with fallback redirection. More... | |
static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
An optional selector, without fallback redirection. 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) |
Selector with external storage of Function1. This also allows wildcard matches in a dictionary. More... | |
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... | |
Protected Member Functions inherited from function1Base | |
void | operator= (const function1Base &)=delete |
No copy assignment. More... | |
Protected Attributes inherited from function1Base | |
const word | name_ |
Name of entry. More... | |
const objectRegistry * | obrPtr_ |
Pointer to an object registry. More... | |
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>; }
Definition at line 68 of file Constant.H.
Constant | ( | const word & | entryName, |
const Type & | value, | ||
const objectRegistry * | obrPtr = nullptr |
||
) |
Construct from components.
Definition at line 28 of file Constant.C.
Constant | ( | const word & | entryName, |
const dictionary & | dict, | ||
const objectRegistry * | obrPtr = nullptr |
||
) |
Construct from entry name, dictionary and optional registry.
Definition at line 41 of file Constant.C.
References dict, entry::isStream(), token::isWord(), ITstream::peek(), ITstream::skip(), and entry::stream().
Construct from entry name and Istream.
Reads the constant value without the Function1 type for backward compatibility
Definition at line 78 of file Constant.C.
Copy constructor.
Definition at line 89 of file Constant.C.
|
virtualdefault |
Destructor.
TypeName | ( | "constant" | ) |
Construct and return a clone.
Implements Function1< Type >.
Reimplemented in Uniform< Type >.
Definition at line 132 of file Constant.H.
|
inline |
Change the constant value.
Definition at line 27 of file ConstantI.H.
|
inlinevirtual |
Value is independent of x.
Reimplemented from Function1< Type >.
Definition at line 154 of file Constant.H.
|
inlinevirtual |
Return constant value.
Reimplemented from Function1< Type >.
Definition at line 34 of file ConstantI.H.
|
inlinevirtual |
Integrate between two values.
Reimplemented from Function1< Type >.
Definition at line 42 of file ConstantI.H.
|
virtual |
Return value as a function of (scalar) independent variable.
Reimplemented from Function1< Type >.
Definition at line 100 of file Constant.C.
References Foam::New(), and x.
|
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().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.