FieldFunction1< Function1Type > Class Template Reference

#include <Function1.H>

Inheritance diagram for FieldFunction1< Function1Type >:

Collaboration diagram for FieldFunction1< Function1Type >:

Public Types
typedef Function1Type::returnType	Type

Public Member Functions
	FieldFunction1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and dictionary.
virtual tmp< Function1< Type > >	clone () const
	Return a clone.
virtual	~FieldFunction1 ()=default
	Destructor.
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable.
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values.

Detailed Description

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

Definition at line 360 of file Function1.H.

Member Typedef Documentation

Type

template<class Function1Type>

typedef Function1Type::returnType Type

Definition at line 366 of file Function1.H.

Constructor & Destructor Documentation

FieldFunction1()

template<class Function1Type>

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

Construct from entry name and dictionary.

Definition at line 119 of file Function1.C.

References dict.

~FieldFunction1()

template<class Function1Type>

virtual ~FieldFunction1 ( )

virtualdefault

Destructor.

References x.

Member Function Documentation

clone()

template<class Function1Type>

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

inlinevirtual

Return a clone.

Definition at line 384 of file Function1.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

value()

template<class Function1Type>

Foam::tmp< Foam::Field< typename Function1Type::returnType > > value ( const scalarField & x ) const

virtual

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

Definition at line 102 of file Function1.C.

References fld(), forAll, Foam::New(), and x.

Here is the call graph for this function:

integrate()

template<class Function1Type>

Foam::tmp< Foam::Field< typename Function1Type::returnType > > integrate ( const scalarField & x1, const scalarField & x2 ) const

virtual

Integrate between two (scalar) values.

Definition at line 132 of file Function1.C.

References fld(), forAll, Foam::New(), and UList< T >::size().

Here is the call graph for this function:

---

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