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")
	Runtime type information. More...

	None (const None< Type > &rhs)=default
	Default copy constructor. More...

void	operator= (const None< Type > &)=delete
	No copy assignment. More...

	None (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

virtual	~None ()=default
	Destructor. More...

virtual bool	constant () const
	Value is independent of x. More...

virtual Type	value (const scalar x) const
	Placeholder: generates an error if called. More...

virtual Type	integral (const scalar x1, const scalar x2) const
	Placeholder: generates an error if called. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Placeholder: generates an error if called. 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)

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

virtual	~Function1 ()=default
	Destructor. 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...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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 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...

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 53 of file NoneFunction1.H.

Constructor & Destructor Documentation

◆ None() [1/2]

None ( const None< Type > & rhs )

default

Default copy constructor.

◆ None() [2/2]

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

Construct from entry name, dictionary and optional registry.

Definition at line 34 of file NoneFunction1.C.

◆ ~None()

virtual ~None ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "none" )

Runtime type information.

◆ operator=()

void operator= ( const None< Type > & )

delete

No copy assignment.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 89 of file NoneFunction1.H.

◆ constant()

virtual bool constant ( ) const

inlinevirtual

Value is independent of x.

Reimplemented from Function1< Type >.

Definition at line 102 of file NoneFunction1.H.

◆ value() [1/2]

Type value ( const scalar x ) const

virtual

Placeholder: generates an error if called.

Reimplemented from Function1< Type >.

Definition at line 48 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

Placeholder: generates an error if called.

Definition at line 60 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

Placeholder: generates an error if called.

Reimplemented from Function1< Type >.

Definition at line 76 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

Write as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 89 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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ None() [1/2]

◆ None() [2/2]

◆ ~None()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ constant()

◆ value() [1/2]

◆ integral()

◆ value() [2/2]

◆ writeData()

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