Public Member Functions | List of all members

This function object calculates the gradient of a field. The operation is limited to scalar and vector volume or surface fields, and the output is a volume vector or tensor field. More...

Public Member Functions

 TypeName ("calcFvcGrad")
 Runtime type information. More...
 
 calcFvcGrad (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~calcFvcGrad ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of calcFvcGrad. More...
 
virtual void read (const dictionary &)
 Read the calcFvcGrad data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Calculate the calcFvcGrad and write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 
template<class Type >
Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > & gradField (const word &gradName, const dimensionSet &dims)
 

Detailed Description

This function object calculates the gradient of a field. The operation is limited to scalar and vector volume or surface fields, and the output is a volume vector or tensor field.

Source files

Definition at line 65 of file calcFvcGrad.H.

Constructor & Destructor Documentation

calcFvcGrad ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 42 of file calcFvcGrad.C.

References Foam::endl(), Foam::nl, Foam::read(), and WarningIn.

Here is the call graph for this function:

~calcFvcGrad ( )
virtual

Destructor.

Definition at line 78 of file calcFvcGrad.C.

Member Function Documentation

TypeName ( "calcFvcGrad"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of calcFvcGrad.

Definition at line 139 of file calcFvcGrad.H.

References calcFvcGrad::end(), calcFvcGrad::execute(), calcFvcGrad::read(), calcFvcGrad::timeSet(), and calcFvcGrad::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the calcFvcGrad data.

Definition at line 84 of file calcFvcGrad.C.

References dictionary::lookup().

Referenced by calcFvcGrad::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 99 of file calcFvcGrad.C.

References Foam::endl(), and WarningIn.

Referenced by calcFvcGrad::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 117 of file calcFvcGrad.C.

Referenced by calcFvcGrad::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 126 of file calcFvcGrad.C.

Referenced by calcFvcGrad::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the calcFvcGrad and write.

Definition at line 132 of file calcFvcGrad.C.

References Foam::endl(), Foam::Info, IOobject::name(), Foam::nl, Foam::type(), and regIOobject::write().

Referenced by calcFvcGrad::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 160 of file calcFvcGrad.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 164 of file calcFvcGrad.H.

Foam::GeometricField< typename Foam::outerProduct<Foam::vector, Type>::type, Foam::fvPatchField, Foam::volMesh>& gradField ( const word gradName,
const dimensionSet dims 
)

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