Public Member Functions | List of all members
FieldFunction1< Type, Function1Type > Class Template Referenceabstract
Inheritance diagram for FieldFunction1< Type, Function1Type >:
Inheritance graph
[legend]
Collaboration diagram for FieldFunction1< Type, Function1Type >:
Collaboration graph
[legend]

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")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const dictionary &dict),(name, dict))
 Declare runtime constructor selection table. 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. 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 170 of file Function1.H.

Constructor & Destructor Documentation

◆ FieldFunction1()

FieldFunction1 ( const word &  name)

Construct from name.

Definition at line 47 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
virtual

Construct and return a clone.

Implements Function1< Type >.

Reimplemented in NSRDS7, NSRDS6, NSRDS5, NSRDS4, NSRDS3, NSRDS2, NSRDS14, NSRDS1, NSRDS0, 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 UniformTable< Type >, NonUniformTable< Type >, NonUniformTable< scalar >, NSRDS7, NSRDS6, NSRDS5, NSRDS4, NSRDS3, NSRDS2, NSRDS14, NSRDS1, NSRDS0, ZeroConstant< Type >, OneConstant< Type >, Constant< Type >, Table< Type >, Table< scalar >, Square< Type >, Sine< Type >, Scale< Type >, Polynomial< Type >, None< Type >, Ramp< reverseRamp >, Ramp< quarterSineRamp >, Ramp< halfCosineRamp >, Ramp< quarterCosineRamp >, Ramp< exponentialSqrRamp >, Ramp< quadraticRamp >, Ramp< linearRamp >, Ramp< Function1Type >, squarePulse, reverseRamp, quarterSineRamp, quarterCosineRamp, quadraticRamp, linearRamp, halfCosineRamp, exponentialSqrRamp, turbulentBL, and laminarBL.

◆ 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 89 of file Function1.C.

References fld(), forAll, tmp< T >::ref(), and x.

Here is the call graph for this function:

◆ 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 NSRDS7, NSRDS6, NSRDS5, NSRDS4, NSRDS3, NSRDS2, NSRDS14, NSRDS1, NSRDS0, ZeroConstant< Type >, UniformTable< Type >, Table< Type >, Table< scalar >, Square< Type >, Sine< Type >, Scale< Type >, Polynomial< Type >, OneConstant< Type >, NonUniformTable< Type >, NonUniformTable< scalar >, None< Type >, Constant< Type >, squarePulse, reverseRamp, quarterSineRamp, quarterCosineRamp, quadraticRamp, linearRamp, halfCosineRamp, exponentialSqrRamp, turbulentBL, and laminarBL.

◆ 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 108 of file Function1.C.

References fld(), forAll, tmp< T >::ref(), and List< T >::size().

Here is the call graph for this function:
The documentation for this class was generated from the following files: