Public Member Functions | List of all members
DistanceFunction< DimensionedFieldType > Class Template Reference

Distance function internal and patch field initialisation function. More...

Inheritance diagram for DistanceFunction< DimensionedFieldType >:
Inheritance graph
[legend]
Collaboration diagram for DistanceFunction< DimensionedFieldType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("distanceFunction")
 Runtime type information. More...
 
 DistanceFunction (const dictionary &dict, DimensionedFieldType &field)
 Construct with dictionary to initialise given field. More...
 
 DistanceFunction (const DistanceFunction &dff, DimensionedFieldType &field)
 Construct a copy for the given field. More...
 
virtual autoPtr< DimensionedFieldFunction< DimensionedFieldType > > clone (DimensionedFieldType &field) const
 Construct and return a clone for the specified field. More...
 
virtual ~DistanceFunction ()
 Destructor. More...
 
virtual void evaluate ()
 Evaluate the function and set the field. More...
 
virtual void write (Ostream &os) const
 Write data to dictionary stream. More...
 
- Public Member Functions inherited from DimensionedFieldFunction< DimensionedFieldType >
 TypeName ("DimensionedFieldFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DimensionedFieldFunction, dictionary,(const dictionary &dict, DimensionedFieldType &field),(dict, field))
 
 DimensionedFieldFunction (const dictionary &dict, DimensionedFieldType &field)
 Construct with dictionary to initialise given field. More...
 
 DimensionedFieldFunction (const DimensionedFieldFunction &dff, DimensionedFieldType &field)
 Construct a copy for the given field. More...
 
 DimensionedFieldFunction (const DimensionedFieldFunction< DimensionedFieldType > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual autoPtr< DimensionedFieldFunction< DimensionedFieldType > > clone () const
 Construct and return a clone for the specified field. More...
 
virtual ~DimensionedFieldFunction ()
 Destructor. More...
 
virtual bool update ()
 Update the field if the function has changed and return true. More...
 
virtual void reset ()
 Reset the field size. More...
 
void operator= (const DimensionedFieldFunction< DimensionedFieldType > &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DimensionedFieldFunction< DimensionedFieldType >
static autoPtr< DimensionedFieldFunction< DimensionedFieldType > > New (const dictionary &dict, DimensionedFieldType &field)
 Select null constructed. More...
 
- Protected Attributes inherited from DimensionedFieldFunction< DimensionedFieldType >
DimensionedFieldType & field_
 Reference to the field the function applies to. More...
 

Detailed Description

template<class DimensionedFieldType>
class Foam::DimensionedFieldFunctions::DistanceFunction< DimensionedFieldType >

Distance function internal and patch field initialisation function.

The field is initialised by evaluating the specified Foam::Function1 of distance in the given spatial direction.

Usage
To set a field with a linear ramp from 0 to 1 over the distance 1 starting at 0 in the x-direction: 
internalField
{
    type        distanceFunction;

    direction   (1 0 0);

    function
    {
        type        linearRamp;
        duration    1;
    }
}
Source files

Definition at line 73 of file DistanceFunction_DimensionedFieldFunction.H.

Constructor & Destructor Documentation

◆ DistanceFunction() [1/2]

DistanceFunction ( const dictionary &  dict,
DimensionedFieldType &  field 
)

Construct with dictionary to initialise given field.

Definition at line 32 of file DistanceFunction_DimensionedFieldFunction.C.

◆ DistanceFunction() [2/2]

DistanceFunction ( const DistanceFunction< DimensionedFieldType > &  dff,
DimensionedFieldType &  field 
)

Construct a copy for the given field.

Definition at line 55 of file DistanceFunction_DimensionedFieldFunction.C.

◆ ~DistanceFunction()

virtual ~DistanceFunction ( )
inlinevirtual

Destructor.

Definition at line 114 of file DistanceFunction_DimensionedFieldFunction.H.

Member Function Documentation

◆ TypeName()

TypeName ( "distanceFunction"  )

Runtime type information.

◆ clone()

Foam::autoPtr< Foam::DimensionedFieldFunction< DimensionedFieldType > > clone ( DimensionedFieldType &  field) const
virtual

Construct and return a clone for the specified field.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 70 of file DistanceFunction_DimensionedFieldFunction.C.

◆ evaluate()

void evaluate
virtual

Evaluate the function and set the field.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 85 of file DistanceFunction_DimensionedFieldFunction.C.

◆ write()

void write ( Ostream &  os) const
virtual

Write data to dictionary stream.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 94 of file DistanceFunction_DimensionedFieldFunction.C.

References Foam::dimLength, and Foam::writeEntry().

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