Public Member Functions | List of all members
scalarTransport Class Reference

This function object evolves a passive scalar transport equation. The field in ininitially zero, to which sources are added. The field name is assigned the name of the function object. Boundary conditions are automatically applied, based on the velocity boundary conditions. More...

Public Member Functions

 TypeName ("scalarTransport")
 Runtime type information. More...
 
 scalarTransport (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~scalarTransport ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of scalarTransport. More...
 
virtual void read (const dictionary &)
 Read the scalarTransport 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 scalarTransport 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...
 

Detailed Description

This function object evolves a passive scalar transport equation. The field in ininitially zero, to which sources are added. The field name is assigned the name of the function object. Boundary conditions are automatically applied, based on the velocity boundary conditions.

- the field can be zeroed on start-up using the resetOnStartUp flag

Source files

Definition at line 70 of file scalarTransport.H.

Constructor & Destructor Documentation

scalarTransport ( 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 143 of file scalarTransport.C.

References Foam::dimless, and Foam::read().

Here is the call graph for this function:

~scalarTransport ( )
virtual

Destructor.

Definition at line 187 of file scalarTransport.C.

Member Function Documentation

TypeName ( "scalarTransport"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of scalarTransport.

Definition at line 152 of file scalarTransport.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the scalarTransport data.

Definition at line 193 of file scalarTransport.C.

References Foam::Info, dictionary::lookup(), dictionary::lookupOrDefault(), Foam::nl, dictionary::readIfPresent(), dictionary::subDict(), and Foam::type().

Referenced by scalarTransport::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 217 of file scalarTransport.C.

References Foam::fvm::ddt(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::fvm::div(), Foam::endl(), FatalErrorInFunction, Foam::Info, Foam::fvm::laplacian(), Foam::nl, fvMatrix< Type >::relax(), rho, fvMatrix< Type >::solve(), TEqn(), and Foam::type().

Referenced by scalarTransport::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 301 of file scalarTransport.C.

Referenced by scalarTransport::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 307 of file scalarTransport.C.

Referenced by scalarTransport::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the scalarTransport and write.

Definition at line 311 of file scalarTransport.C.

Referenced by scalarTransport::name().

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 173 of file scalarTransport.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 177 of file scalarTransport.H.


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