All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
scalarTransport Class Reference

Evolves a passive scalar transport equation. More...

Inheritance diagram for scalarTransport:
Collaboration diagram for scalarTransport:

Public Types

enum  diffusionType { none, constant, viscosity }
 Enumeration defining the type of the diffusion. More...
 

Public Member Functions

 TypeName ("scalarTransport")
 Runtime type information. More...
 
 scalarTransport (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 scalarTransport (const scalarTransport &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~scalarTransport ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the scalarTransport data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Calculate the scalarTransport. More...
 
virtual bool write ()
 Do nothing. More...
 
void operator= (const scalarTransport &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

Evolves a passive scalar transport equation.

- To specify the field name set the field entry

  • To employ the same numerical schemes as another field set the schemesField entry,
  • The diffusivity entry can be set to none, constant, viscosity
  • A constant diffusivity is specified with the D entry,
  • If a momentum transport model is available and the viscosity diffusivity option specified an effective diffusivity may be constructed from the laminar and turbulent viscosities using the diffusivity coefficients alphal and alphat:
          D = alphal*nu + alphat*nut

Example:

    #includeFunc scalarTransport(T, alphal=1, alphat=1)

For incompressible flow the passive scalar may optionally be solved with the MULES limiter and sub-cycling or semi-implicit in order to maintain boundedness, particularly if a compressive, PLIC or MPLIC convection scheme is used.

Example:

    #includeFunc scalarTransport(tracer, diffusion=none)

with scheme specification:
    div(phi,tracer)     Gauss interfaceCompression vanLeer 1;

and solver specification:
    tracer
    {
        nCorr      1;
        nSubCycles 3;

        MULESCorr       no;
        nLimiterIter    5;
        applyPrevCorr   yes;

        solver          smoothSolver;
        smoother        symGaussSeidel;
        tolerance       1e-8;
        relTol          0;

        diffusion
        {
            solver          smoothSolver;
            smoother        symGaussSeidel;
            tolerance       1e-8;
            relTol          0;
        }
    }
See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 109 of file scalarTransport.H.

Member Enumeration Documentation

◆ diffusionType

enum diffusionType
strong

Enumeration defining the type of the diffusion.

Enumerator
none 
constant 
viscosity 

Definition at line 116 of file scalarTransport.H.

Constructor & Destructor Documentation

◆ scalarTransport() [1/2]

scalarTransport ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 117 of file scalarTransport.C.

References IOobject::AUTO_WRITE, Foam::endl(), dictionary::found(), IOobject::groupName(), typeIOobject< Type >::headerOk(), Foam::Info, Foam::fvc::interpolate(), dictionary::lookupOrDefault(), phi, Foam::read(), IOobject::READ_IF_PRESENT, and Time::timeName().

Referenced by NamedEnum< compressibleField, 8 >::names().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scalarTransport() [2/2]

scalarTransport ( const scalarTransport )
delete

Disallow default bitwise copy construction.

◆ ~scalarTransport()

~scalarTransport ( )
virtual

Destructor.

Definition at line 195 of file scalarTransport.C.

Member Function Documentation

◆ TypeName()

TypeName ( "scalarTransport"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the scalarTransport data.

Reimplemented from regionFunctionObject.

Definition at line 201 of file scalarTransport.C.

References dictionary::lookup(), dictionary::lookupOrDefault(), regionFunctionObject::read(), dictionary::readIfPresent(), and viscosity().

Here is the call graph for this function:

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 232 of file scalarTransport.C.

◆ execute()

◆ write()

bool write ( )
virtual

Do nothing.

The volScalarField is registered and written automatically

Implements functionObject.

Definition at line 635 of file scalarTransport.C.

◆ operator=()

void operator= ( const scalarTransport )
delete

Disallow default bitwise assignment.


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