FieldFunction1< Type, Function1Type > Class Template Reference

Inheritance diagram for FieldFunction1< Type, Function1Type >:

Collaboration diagram for FieldFunction1< Type, Function1Type >:

Public Member Functions
	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 Type	value (const scalar x) const =0
	Return value as a function of one scalars. More...
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...
virtual Type	integral (const scalar x1, const scalar x2) const =0
	Integrate between two scalar values. 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") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...
	Function1 (const word &name)
	Construct from name. More...
	Function1 (const Function1< Type > &f1)
	Copy constructor. More...
virtual	~Function1 ()
	Destructor. More...
const word &	name () const
	Return the name of the entry. More...
virtual void	write (Ostream &os) 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...

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 dictionary &dict)
	Selector. More...
Public Attributes inherited from Function1< Type >
	Function1
	dictionary
const word &	name
const word const dictionary &	dict
const word const dictionary	name
const word const dictionary	dict
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...
Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

Detailed Description

template<class Type, class Function1Type>
class Foam::FieldFunction1< Type, Function1Type >

Definition at line 169 of file Function1.H.

Constructor & Destructor Documentation

FieldFunction1()

FieldFunction1

(

const word &

name

)

Construct from name.

Definition at line 48 of file Function1.C.

~FieldFunction1()

~FieldFunction1 ( )

virtual

Destructor.

Definition at line 75 of file Function1.C.

Member Function Documentation

clone()

Foam::tmp< Foam::Function1< Type > > clone ( ) const

virtual

Construct and return a clone.

Implements Function1< Type >.

Reimplemented in NSRDS0, NSRDS6, NSRDS1, NSRDS14, NSRDS4, NSRDS7, NSRDS2, NSRDS3, NSRDS5, and Constant< Type >.

Definition at line 58 of file Function1.C.

value() [1/2]

virtual Type value ( const scalar  x ) const

pure virtual

Return value as a function of one scalars.

Implements Function1< Type >.

Implemented in Scale< Type >, Table< Type >, Table< scalar >, Square< Type >, Sine< Type >, Ramp< Function1Type >, Ramp< reverseRamp >, Ramp< quarterSineRamp >, Ramp< halfCosineRamp >, Ramp< quarterCosineRamp >, Ramp< quadraticRamp >, Ramp< linearRamp >, squarePulse, NonUniformTable< Type >, NonUniformTable< scalar >, UniformTable< Type >, reverseRamp, NSRDS0, NSRDS6, NSRDS1, NSRDS14, NSRDS4, NSRDS7, NSRDS2, NSRDS3, NSRDS5, Polynomial< Type >, Constant< Type >, OneConstant< Type >, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, quarterSineRamp, ZeroConstant< Type >, and None< Type >.

Referenced by FieldFunction1< Type, Sine< Type > >::~FieldFunction1().

Here is the caller graph for this function:

value() [2/2]

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

virtual

Return value as a function of one scalar field.

Implements Function1< Type >.

Definition at line 90 of file Function1.C.

integral() [1/2]

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

pure virtual

Integrate between two scalar values.

Implements Function1< Type >.

Implemented in Scale< Type >, Table< Type >, Table< scalar >, Square< Type >, Sine< Type >, squarePulse, NonUniformTable< Type >, NonUniformTable< scalar >, NSRDS14, UniformTable< Type >, NSRDS6, NSRDS0, NSRDS1, NSRDS4, NSRDS7, reverseRamp, NSRDS2, NSRDS3, NSRDS5, Polynomial< Type >, Constant< Type >, OneConstant< Type >, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, quarterSineRamp, ZeroConstant< Type >, and None< Type >.

Referenced by FieldFunction1< Type, Sine< Type > >::value().

Here is the caller graph for this function:

integral() [2/2]

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

virtual

Integrate between two scalar fields.

Implements Function1< Type >.

Definition at line 109 of file Function1.C.

---

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