Public Member Functions | List of all members
age Class Reference

Calculates and writes out the time taken for a particle to travel from an inlet to the location. Solves the following equation when incompressible: More...

Inheritance diagram for age:
Inheritance graph
[legend]
Collaboration diagram for age:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("age")
 
 age (const word &name, const Time &runTime, const dictionary &dict)
 
virtual ~age ()=default
 
virtual bool read (const dictionary &)
 
virtual bool execute ()
 
virtual bool write ()
 
template<class GeoField >
Foam::autoPtr< GeoField > newField (const word &baseName, const wordList patches) const
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~fvMeshFunctionObject ()=default
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~regionFunctionObject ()=default
 
template<class ObjectType >
const ObjectType * lookupObjectPtr (const word &fieldName) const
 
template<class ObjectType >
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 
- Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 
virtual ~stateFunctionObject ()=default
 
dictionary & propertyDict ()
 
bool foundProperty (const word &entryName) const
 
void clearTrigger ()
 
label getTrigger () const
 
bool setTrigger (const label triggeri, bool increaseOnly=true)
 
bool getDict (const word &entryName, dictionary &dict) const
 
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 
template<class Type >
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getProperty (const word &entryName, Type &value) const
 
template<class Type >
void setProperty (const word &entryName, const Type &value)
 
template<class Type >
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 
template<class Type >
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
void setResult (const word &entryName, const Type &value)
 
template<class Type >
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 
word resultType (const word &entryName) const
 
word objectResultType (const word &objectName, const word &entryName) const
 
wordList objectResultEntries () const
 
wordList objectResultEntries (const word &objectName) const
 
void writeResultEntries (Ostream &os) const
 
void writeResultEntries (const word &objectName, Ostream &os) const
 
void writeAllResultEntries (Ostream &os) const
 
- Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 
virtual ~timeFunctionObject ()=default
 
const Time & time () const
 
objectRegistry & storedObjects ()
 
const objectRegistry & storedObjects () const
 
- Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 
autoPtr< functionObject > clone () const
 
virtual ~functionObject ()=default
 
virtual const word & type () const =0
 
const word & name () const noexcept
 
bool useNamePrefix () const noexcept
 
bool useNamePrefix (bool on) noexcept
 
virtual bool execute (const label subIndex)
 
virtual bool end ()
 
virtual bool adjustTimeStep ()
 
virtual bool filesModified () const
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &mesh)
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObject > New (const word &name, const Time &runTime, const dictionary &dict)
 
- Public Attributes inherited from functionObject
bool log
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 
- Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 
void operator= (const fvMeshFunctionObject &)=delete
 
- Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry & obr () const
 
template<class ObjectType >
bool foundObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * cfindObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * findObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType * findObject (const word &fieldName)
 
template<class ObjectType >
ObjectType * getObjectPtr (const word &fieldName) const
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName) const
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 
template<class ObjectType >
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 
bool writeObject (const word &fieldName)
 
bool clearObject (const word &fieldName)
 
void clearObjects (const wordList &objNames)
 
 regionFunctionObject (const regionFunctionObject &)=delete
 
void operator= (const regionFunctionObject &)=delete
 
- Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties & stateDict () const
 
functionObjects::properties & stateDict ()
 
 stateFunctionObject (const stateFunctionObject &)=delete
 
void operator= (const stateFunctionObject &)=delete
 
- Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 
 timeFunctionObject (const timeFunctionObject &)=delete
 
void operator= (const timeFunctionObject &)=delete
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMesh & mesh_
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 
const objectRegistry & obr_
 
const objectRegistry * obrPtr_
 
- Protected Attributes inherited from timeFunctionObject
const Time & time_
 

Detailed Description

Calculates and writes out the time taken for a particle to travel from an inlet to the location. Solves the following equation when incompressible:

\[ \div (\phi t) = 1 \]

where

$ t $ = Age [s]
$ \phi $ = Volumetric flux [m^3/s]

Boundary conditions are generated automatically as zeroGradient on all walls and inletOutlet everywhere else.

Usage
Minimal example by using system/controlDict.functions: 
age1
{
    // Mandatory entries
    type            age;
    libs            (fieldFunctionObjects);

    // Optional entries
    phi             <word>;
    rho             <word>;
    schemesField    <word>;
    tolerance       <scalar>;
    nCorr           <int>;
    diffusion       <bool>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: age word yes -
libs Library name: fieldFunctionObjects word yes -
phi Name of flux field word no phi
rho Name of density field word no rho
schemesField Name of the field from which schemes are taken word no age
tolerance Solver residual control scalar no 1e-5
nCorr Maximum number of correctors int no 5
diffusion Flag to turn on/off the diffusion term bool no false

The inherited entries are elaborated in:

See also
Source files

Definition at line 170 of file age.H.

Constructor & Destructor Documentation

◆ age()

age ( const word &  name,
const Time &  runTime,
const dictionary &  dict 
)

Definition at line 114 of file age.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~age()

virtual ~age ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "age"  )

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from regionFunctionObject.

Definition at line 128 of file age.C.

References dict, Foam::constant::electromagnetic::e, and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 146 of file age.C.

References IOobject::AUTO_WRITE, Foam::dimMass, Foam::dimTime, Foam::fvm::div(), Foam::endl(), fvOptions, Foam::Info, Foam::fvm::laplacian(), Foam::max(), Foam::min(), options::New(), tmp::New(), patchTypes(), phi, turbulenceModel::propertiesName, IOobject::READ_IF_PRESENT, fvMatrix::relax(), rho, and fvMatrix::solve().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Implements functionObject.

Definition at line 283 of file age.C.

◆ newField()

Foam::autoPtr<GeoField> newField ( const word &  baseName,
const wordList  patches 
) const

Definition at line 89 of file age.C.

References Foam::dimTime, autoPtr::New(), IOobject::NO_READ, IOobject::NO_WRITE, patches, and Foam::Zero.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17