Run-time selectable general function of one variable. More...

Inheritance diagram for Function1< Type >:

[legend]

Collaboration diagram for Function1< Type >:

Public Types
typedef Type	returnType

Public Member Functions
	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 tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~Function1 ()
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

virtual Type	value (const scalar x) const =0
	Return value as a function of scalar x. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const =0
	Return value as a function of a scalar field x. More...

virtual Type	integral (const scalar x1, const scalar x2) const =0
	Integrate between two scalars. More...

virtual tmp< Field< Type > >	integral (const scalarField &x1, const scalarField &x2) const =0
	Integrate between two scalar fields. More...

virtual bool	constant () const
	Is this function guaranteed to be constant? More...

virtual void	write (Ostream &os, const Function1s::unitConversions &) const =0
	Write data to dictionary stream. 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...

Static Public Member Functions
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 Attributes
const word	name_
	Name of entry. More...

Friends
Ostream &	operator (Ostream &os, const Function1< Type > &func)
	Ostream Operator. More...

Additional Inherited Members
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Detailed Description

template<class Type>
class Foam::Function1< Type >

Run-time selectable general function of one variable.

with many options provided from simple constant values to complex functions, interpolated tabulated data etc. etc.

Source files

Definition at line 122 of file Function1.H.

Member Typedef Documentation

◆ returnType

typedef Type returnType

Definition at line 137 of file Function1.H.

Constructor & Destructor Documentation

◆ Function1() [1/2]

Function1 ( const word & name )

Construct from name.

Definition at line 31 of file Function1.C.

◆ Function1() [2/2]

Function1 ( const Function1< Type > & f1 )

Copy constructor.

Definition at line 38 of file Function1.C.

◆ ~Function1()

~Function1

virtual

Destructor.

Definition at line 66 of file Function1.C.

Member Function Documentation

◆ TypeName()

TypeName ( "Function1< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		Function1< Type >	,
		dictionary	,
		(const word &name, const Function1s::unitConversions &units, const dictionary &dict)	,
		(name, units, dict)
	)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		Function1< Type >	,
		Istream	,
		(const word &name, const Function1s::unitConversions &units, Istream &is)	,
		(name, units, is)
	)

◆ clone()

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

pure virtual

Construct and return a clone.

◆ New() [1/4]

Foam::autoPtr< Foam::Function1< Type > > New	(	const word &	name,
		const Function1s::unitConversions &	units,
		const dictionary &	dict
	)

static

Select from dictionary.

Definition at line 31 of file Function1New.C.

References dict, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, IOWarningInFunction, token::isWord(), dictionary::lookup(), Foam::name(), Foam::compressible::New(), Foam::nl, Istream::putBack(), and Foam::units().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/4]

Foam::autoPtr< Foam::Function1< Type > > New	(	const word &	name,
		const unitConversion &	xUnits,
		const unitConversion &	valueUnits,
		const dictionary &	dict
	)

static

Select from dictionary.

Definition at line 121 of file Function1New.C.

References dict, Foam::name(), and Foam::compressible::New().

Here is the call graph for this function:

◆ New() [3/4]

Foam::autoPtr< Foam::Function1< Type > > New	(	const word &	name,
		const Function1s::unitConversions &	units,
		const word &	Function1Type,
		Istream &	is
	)

static

Select from Istream.

Definition at line 134 of file Function1New.C.

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

Here is the call graph for this function:

◆ New() [4/4]

Foam::autoPtr< Foam::Function1< Type > > New	(	const word &	name,
		const unitConversion &	xUnits,
		const unitConversion &	valueUnits,
		const word &	Function1Type,
		Istream &	is
	)

static

Select from Istream.

Definition at line 178 of file Function1New.C.

References Foam::name(), and Foam::compressible::New().

Here is the call graph for this function:

◆ name()

const Foam::word & name

Return the name of the entry.

Definition at line 78 of file Function1.C.

Referenced by NonUniformTable< Type >::NonUniformTable(), Polynomial< Type >::Polynomial(), and Foam::writeEntry().

Here is the caller graph for this function:

◆ value() [1/2]

virtual Type value ( const scalar x ) const

pure virtual

Return value as a function of scalar x.

◆ value() [2/2]

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

pure virtual

Return value as a function of a scalar field x.

◆ integral() [1/2]

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

pure virtual

Integrate between two scalars.

◆ integral() [2/2]

virtual tmp<Field<Type> > integral	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

pure virtual

Integrate between two scalar fields.

◆ constant()

bool constant

virtual

Is this function guaranteed to be constant?

Reimplemented in Scale< Type >, Constant< Type >, and Add< Type >.

Definition at line 85 of file Function1.C.

◆ write()

virtual void write	(	Ostream &	os,
		const Function1s::unitConversions &
	)		const

pure virtual

Write data to dictionary stream.

Implemented in NSRDS7, NSRDS6, NSRDS5, NSRDS4, NSRDS3, NSRDS2, NSRDS14, NSRDS1, NSRDS0, integratedNonUniformTable, ZeroConstant< Type >, UniformTable< Type >, Table< Type >, Table< scalar >, squarePulse, Square< Type >, Sine< Type >, Shift< Type >, Scale< Type >, reverseRamp, Repeat< Type >, Ramp< Function1Type >, Ramp< reverseRamp >, Ramp< quarterSineRamp >, Ramp< halfCosineRamp >, Ramp< quarterCosineRamp >, Ramp< exponentialSqrRamp >, Ramp< quadraticRamp >, Ramp< linearRamp >, Polynomial< Type >, OneConstant< Type >, normalise, NonUniformTable< Type >, NonUniformTable< scalar >, None< Type >, Constant< Type >, Coded< Type >, Add< Type >, crankConnectingRodMotion, turbulentBL, and laminarBL.

Referenced by Foam::writeEntry().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const Function1< Type > & f )

Assignment.

Definition at line 133 of file Function1.C.

References Foam::abort(), f(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	os,
		const Function1< Type > &	func
	)

friend

Ostream Operator.

Member Data Documentation

◆ name_

const word name_

protected

Name of entry.

Definition at line 132 of file Function1.H.

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

src/OpenFOAM/primitives/functions/Function1/Function1/Function1.H
src/OpenFOAM/primitives/functions/Function1/Function1/Function1.C
src/OpenFOAM/primitives/functions/Function1/Function1/Function1New.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::Function1< Type >

Member Typedef Documentation

◆ returnType

Constructor & Destructor Documentation

◆ Function1() [1/2]

◆ Function1() [2/2]

◆ ~Function1()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone()

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ name()

◆ value() [1/2]

◆ value() [2/2]

◆ integral() [1/2]

◆ integral() [2/2]

◆ constant()

◆ write()

◆ operator=()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ name_

template<class Type>
class Foam::Function1< Type >