FunctionObjectValue< Type > Class Template Reference

Returns a value retrieved from a function object result. More...

Inheritance diagram for FunctionObjectValue< Type >:
[legend]
Collaboration diagram for FunctionObjectValue< Type >:
[legend]

Public Member Functions

 TypeName ("functionObjectValue")
 Runtime type information. More...
 
void operator= (const FunctionObjectValue< Type > &)=delete
 No copy assignment. More...
 
 FunctionObjectValue (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary and optional registry. More...
 
 FunctionObjectValue (const FunctionObjectValue< Type > &rhs)
 Copy construct. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FunctionObjectValue ()=default
 Destructor. More...
 
virtual Type value (const scalar) const
 Return value at current time. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. Not implemented! More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
virtual void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary 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 tmp< Function1< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~Function1 ()=default
 Destructor. More...
 
virtual bool constant () const
 Is value constant (i.e. independent of x) More...
 
virtual bool good () const
 Can function be evaluated? More...
 
virtual Type value (const scalar x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. 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 in dictionary format. 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 wordname () const noexcept
 The name of the entry. More...
 
const objectRegistrywhichDb () 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 objectRegistryobr () const
 Return the object registry. More...
 
bool isTime () const noexcept
 Return true if this function was created with the time database. More...
 
const Timetime () const
 Return the time database. More...
 
template<class MeshType >
const MeshType & mesh (const word &regionName=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 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
 
- 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 wordentryName
 
const word const dictionarydict
 
const word const dictionary const objectRegistryobrPtr
 
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 objectRegistryobrPtr_
 Pointer to an object registry. More...
 

Detailed Description

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

Returns a value retrieved from a function object result.

Usage:

    <entryName> functionObjectValue;
    <entryName>Coeffs
    {
        functionObject          <name>;
        functionObjectResult    <function object result field>;
        defaultValue            <value>; // optional
    }
Note
Source files

Definition at line 68 of file FunctionObjectValue.H.

Constructor & Destructor Documentation

◆ FunctionObjectValue() [1/2]

FunctionObjectValue ( const word entryName,
const dictionary dict,
const objectRegistry obrPtr = nullptr 
)

Construct from entry name, dictionary and optional registry.

Definition at line 45 of file FunctionObjectValue.C.

References Function1< Type >::dict.

◆ FunctionObjectValue() [2/2]

FunctionObjectValue ( const FunctionObjectValue< Type > &  rhs)
explicit

Copy construct.

Definition at line 63 of file FunctionObjectValue.C.

◆ ~FunctionObjectValue()

virtual ~FunctionObjectValue ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "functionObjectValue"  )

Runtime type information.

◆ operator=()

void operator= ( const FunctionObjectValue< Type > &  )
delete

No copy assignment.

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 119 of file FunctionObjectValue.H.

◆ value()

Type value ( const  scalar) const
inlinevirtual

Return value at current time.

Reimplemented from Function1< Type >.

Definition at line 33 of file FunctionObjectValueI.H.

References DebugInfo, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ integrate()

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

Integrate between two (scalar) values. Not implemented!

Reimplemented from Function1< Type >.

Definition at line 91 of file FunctionObjectValueI.H.

References NotImplemented.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 95 of file FunctionObjectValue.C.

References Foam::name(), and os().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream os) const
virtual

Write coefficient entries in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 79 of file FunctionObjectValue.C.

References os().

Here is the call graph for this function:

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