None< Type > Class Template Reference

Undefined Function1 which returns an error when called. More...

Inheritance diagram for None< Type >:
Collaboration diagram for None< Type >:

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 None (const word &name)
 Construct from name. More...
 
 None (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual ~None ()
 Destructor. More...
 
virtual Type value (const scalar x) const
 Generates an error. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Generates an error. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write in dictionary format. More...
 
void operator= (const None< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< Type, None< Type > >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< Type > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function1s::None< Type >

Undefined Function1 which returns an error when called.

Definition at line 48 of file None.H.

Constructor & Destructor Documentation

◆ None() [1/2]

None ( const word name)

Construct from name.

Definition at line 31 of file None.C.

◆ None() [2/2]

None ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 39 of file None.C.

◆ ~None()

~None
virtual

Destructor.

Definition at line 54 of file None.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ value()

Type value ( const scalar  x) const
virtual

Generates an error.

Implements FieldFunction1< Type, None< Type > >.

Definition at line 61 of file None.C.

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

Here is the call graph for this function:

◆ integral()

Type integral ( const scalar  x1,
const scalar  x2 
) const
virtual

Generates an error.

Implements FieldFunction1< Type, None< Type > >.

Definition at line 74 of file None.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write in dictionary format.

Implements Function1< Type >.

Definition at line 87 of file None.C.

◆ operator=()

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

Disallow default bitwise assignment.


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