None< Type > Class Template Reference

Templated placeholder function that returns an error message if called. More...

Inheritance diagram for None< Type >:

Collaboration diagram for None< Type >:

Public Member Functions
	TypeName ("none")
	None (const None< Type > &rhs)=default
void	operator= (const None< Type > &)=delete
	None (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
virtual tmp< Function1< Type > >	clone () const
virtual	~None ()=default
virtual bool	constant () const
virtual Type	value (const scalar x) const
virtual Type	integral (const scalar x1, const scalar x2) const
virtual tmp< Field< Type > >	value (const scalarField &x) const
virtual void	writeData (Ostream &os) const
Public Member Functions inherited from Function1< Type >
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Function1 (const Function1< Type > &rhs)
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
virtual tmp< Function1< Type > >	clone () const=0
virtual	~Function1 ()=default
virtual bool	constant () const
virtual Type	integrate (const scalar x1, const scalar x2) const
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
void	writeEntries (Ostream &os) const

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)
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
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)
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)
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
Public Attributes inherited from Function1< Type >
	Function1
	dictionary
const word &	entryName
const word const dictionary const objectRegistry	entryName
const word const dictionary &	dict
const word const dictionary const objectRegistry	dict
const word const dictionary const objectRegistry *	obrPtr
const word const dictionary const objectRegistry	obrPtr
Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete

Detailed Description

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

Templated placeholder function that returns an error message if called.

This is principally useful for interfaces that expect a Function1 but where it is not necessarily used by a particular submodel.

Definition at line 47 of file NoneFunction1.H.

Constructor & Destructor Documentation

None() [1/2]

None ( const None< Type > &  rhs )

default

None() [2/2]

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

Definition at line 27 of file NoneFunction1.C.

~None()

virtual ~None ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"none"

)

operator=()

void operator= ( const None< Type > &  )

delete

clone()

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

inlinevirtual

Definition at line 83 of file NoneFunction1.H.

constant()

virtual bool constant ( ) const

inlinevirtual

Definition at line 96 of file NoneFunction1.H.

value() [1/2]

Type value ( const scalar  x ) const

virtual

Reimplemented from Function1< Type >.

Definition at line 41 of file NoneFunction1.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

Definition at line 53 of file NoneFunction1.C.

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

Here is the call graph for this function:

value() [2/2]

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

virtual

Reimplemented from Function1< Type >.

Definition at line 69 of file NoneFunction1.C.

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

Here is the call graph for this function:

writeData()

void writeData ( Ostream &  os ) const

virtual

Reimplemented from Function1< Type >.

Definition at line 82 of file NoneFunction1.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/None/NoneFunction1.H
• src/OpenFOAM/primitives/functions/Function1/None/NoneFunction1.C