Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or table, and provide functions to return the (interpolated) value, and integral between limits. More...

Inheritance diagram for Function1< Type >:

[legend]

Collaboration diagram for Function1< Type >:

[legend]

Public Types
typedef Type	returnType

Public Member Functions
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	Function1 (const word &entryName)
	Construct from entry 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 void	convertTimeBase (const Time &t)
	Convert time. More...

virtual Type	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const =0
	Return value as a function of (scalar) independent variable. 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 =0
	Integrate between two (scalar) values. More...

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

Static Public Member Functions
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict)
	Selector. More...

Public Attributes
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary	entryName

const word const dictionary	dict

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 initializing count to 0. More...

Detailed Description

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

Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or table, and provide functions to return the (interpolated) value, and integral between limits.

Source files

Definition at line 114 of file verticalDamping.H.

Member Typedef Documentation

◆ returnType

typedef Type returnType

Definition at line 81 of file Function1.H.

Constructor & Destructor Documentation

◆ Function1() [1/2]

Function1 ( const word & entryName )

Construct from entry name.

◆ Function1() [2/2]

Function1 ( const Function1< Type > & f1 )

Copy constructor.

◆ ~Function1()

~Function1 ( )

virtual

Destructor.

Definition at line 49 of file Function1.C.

Member Function Documentation

◆ TypeName()

TypeName ( "Function1< Type >" )

Runtime type information.

Declare runtime constructor selection table

◆ clone()

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

pure virtual

Construct and return a clone.

Implemented in Constant< Type >, and OneConstant< Type >.

◆ New()

Foam::autoPtr< Foam::Function1< Type > > New	(	const word &	entryName,
		const dictionary &	dict
	)

static

Selector.

Definition at line 32 of file Function1New.C.

Referenced by CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), setTimeStepFunctionObject::read(), strainRateFunction::read(), velocityRamping::read(), verticalDamping::read(), temperatureDependent::readDict(), and rigidBodyMeshMotion::rigidBodyMeshMotion().

Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const

Return the name of the entry.

Definition at line 56 of file Function1.C.

Referenced by TableFile< Type >::writeData(), CSV< Type >::writeData(), Scale< Type >::writeData(), Sine< Type >::writeData(), and Square< Type >::writeData().

Here is the caller graph for this function:

◆ convertTimeBase()

void convertTimeBase ( const Time & t )

virtual

Convert time.

Reimplemented in TableBase< Type >, and Polynomial< Type >.

Definition at line 63 of file Function1.C.

◆ value() [1/2]

Type value ( const scalar x ) const

virtual

Return value as a function of (scalar) independent variable.

Reimplemented in Square< Type >, Sine< Type >, TableBase< Type >, ramp, Scale< Type >, Polynomial< Type >, Constant< Type >, OneConstant< Type >, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, quarterSineRamp, and ZeroConstant< Type >.

Definition at line 68 of file Function1.C.

Referenced by FieldFunction1< Function1Type >::~FieldFunction1().

Here is the caller graph for this function:

◆ value() [2/2]

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

pure virtual

Return value as a function of (scalar) independent variable.

Implemented in Constant< Type >, and OneConstant< Type >.

◆ integrate() [1/2]

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented in TableBase< Type >, Polynomial< Type >, Constant< Type >, OneConstant< Type >, and ZeroConstant< Type >.

Definition at line 77 of file Function1.C.

Referenced by FieldFunction1< Function1Type >::~FieldFunction1().

Here is the caller graph for this function:

◆ integrate() [2/2]

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

pure virtual

Integrate between two (scalar) values.

Implemented in Constant< Type >, Constant< Type >, OneConstant< Type >, and Constant< Type >.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented in Square< Type >, Sine< Type >, TableBase< Type >, ramp, Scale< Type >, CSV< Type >, Polynomial< Type >, Constant< Type >, TableFile< Type >, OneConstant< Type >, and ZeroConstant< Type >.

Definition at line 146 of file Function1.C.

Referenced by OneConstant< Type >::writeData(), TableFile< Type >::writeData(), Constant< Type >::writeData(), Polynomial< Type >::writeData(), CSV< Type >::writeData(), ramp::writeData(), Scale< Type >::writeData(), TableBase< Type >::writeData(), Sine< Type >::writeData(), and Square< Type >::writeData().

Here is the caller 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 76 of file Function1.H.

◆ Function1

Function1

Definition at line 90 of file Function1.H.

◆ dictionary

dictionary

Definition at line 90 of file Function1.H.

◆ entryName [1/2]

const word& entryName

Definition at line 90 of file Function1.H.

◆ dict [1/2]

const word const dictionary& dict

Definition at line 90 of file Function1.H.

◆ entryName [2/2]

const word const dictionary entryName

Definition at line 90 of file Function1.H.

◆ dict [2/2]

const word const dictionary dict

Definition at line 90 of file Function1.H.

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

src/fvOptions/sources/derived/verticalDamping/verticalDamping.H
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

Public Attributes

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()

◆ clone()

◆ New()

◆ name()

◆ convertTimeBase()

◆ value() [1/2]

◆ value() [2/2]

◆ integrate() [1/2]

◆ integrate() [2/2]

◆ writeData()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ name_

◆ Function1

◆ dictionary

◆ entryName [1/2]

◆ dict [1/2]

◆ entryName [2/2]

◆ dict [2/2]

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