Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
faceSetOption Class Reference

Intermediate abstract class for handling face-set options for the derived faOptions. More...

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

Public Types

enum  selectionModeType { smAll, smVolFaceZone }
 

Public Member Functions

 TypeName ("faceSetOption")
 
 faceSetOption (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 
virtual ~faceSetOption ()=default
 
scalar timeStart () const noexcept
 
scalar duration () const noexcept
 
bool inTimeLimits (const scalar timeValue) const
 
selectionModeType selectionMode () const noexcept
 
bool useSubMesh () const noexcept
 
const word & faceSetName () const noexcept
 
scalar A () const noexcept
 
const labelList & faces () const noexcept
 
scalar timeStart (scalar val) noexcept
 
scalar duration (scalar val) noexcept
 
virtual bool isActive ()
 
virtual bool read (const dictionary &dict)
 
- Public Member Functions inherited from option
 TypeName ("option")
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch),(name, modelType, dict, patch))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 
autoPtr< option > clone () const
 
virtual ~option ()=default
 
const word & name () const noexcept
 
const fvMesh & mesh () const noexcept
 
const fvPatch & patch () const noexcept
 
const dictionary & coeffs () const noexcept
 
bool active () const noexcept
 
void setApplied (const label fieldi)
 
const word & regionName () const noexcept
 
const faMesh & regionMesh () const
 
const volSurfaceMapping & vsm () const
 
bool active (const bool on) noexcept
 
virtual label applyToField (const word &fieldName) const
 
virtual void checkApplied () const
 
virtual void addSup (const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (areaScalarField &field)
 
virtual void correct (areaVectorField &field)
 
virtual void correct (areaSphericalTensorField &field)
 
virtual void correct (areaSymmTensorField &field)
 
virtual void correct (areaTensorField &field)
 
virtual void writeHeader (Ostream &) const
 
virtual void writeFooter (Ostream &) const
 
virtual void writeData (Ostream &) const
 

Static Public Attributes

static const Enum< selectionModeType > selectionModeTypeNames_
 

Protected Member Functions

void setSelection (const dictionary &dict)
 
void setFaceSelection ()
 
void setArea ()
 
- Protected Member Functions inherited from option
void resetApplied ()
 

Protected Attributes

scalar timeStart_
 
scalar duration_
 
selectionModeType selectionMode_
 
word faceSetName_
 
labelList faces_
 
scalar A_
 
- Protected Attributes inherited from option
const word name_
 
const word modelType_
 
const fvMesh & mesh_
 
const fvPatch & patch_
 
dictionary dict_
 
dictionary coeffs_
 
wordList fieldNames_
 
List< bool > applied_
 
word regionName_
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< option > New (const word &name, const dictionary &dict, const fvPatch &patch)
 
- Public Attributes inherited from option
bool log
 

Detailed Description

Intermediate abstract class for handling face-set options for the derived faOptions.

Usage
Minimal example by using constant/faOptions: 
<userDefinedName1>
{
    // Mandatory/Optional (inherited) entries
    ...

    // Mandatory entries (unmodifiable)
    selectionMode     all;

    // Optional entries (runtime modifiable)
    timeStart         1.0;

    // Conditional mandatory entries (runtime modifiable)

        // when timeStart entry is present
        duration          1.4;

        // when selectionMode=volFaceZone
        faceZone          <faceZoneName>;
}

where the entries mean:

Property Description Type Reqd Dflt
selectionMode Mode of face selection - see below word yes -
timeStart Start time of faOption scalar no -1
duration Duration of faOption execution starting from timeStart scalar cndtnl 0
faceZone Name of operand faceZone word cndtnl -

Options for the selectionMode entry: 

      all       | Use all faces in the computational domain
      faceZone  | Use a given faceZone

The inherited entries are elaborated in:

Note
  • Source/sink options are to be added to the right-hand side of equations.
Source files

Definition at line 130 of file faceSetOption.H.

Member Enumeration Documentation

◆ selectionModeType

enum selectionModeType
Enumerator
smAll 
smVolFaceZone 

Definition at line 139 of file faceSetOption.H.

Constructor & Destructor Documentation

◆ faceSetOption()

faceSetOption ( const word &  name,
const word &  modelType,
const dictionary &  dict,
const fvPatch &  patch 
)

Definition at line 170 of file faceSetOption.C.

References Foam::decrIndent(), dict, Foam::incrIndent(), Foam::Info, and Foam::read().

Here is the call graph for this function:

◆ ~faceSetOption()

virtual ~faceSetOption ( )
virtualdefault

Member Function Documentation

◆ setSelection()

void setSelection ( const dictionary &  dict)
protected

Definition at line 48 of file faceSetOption.C.

References dict, Foam::exit(), faceSetOption::faceSetName_, Foam::FatalError, FatalErrorInFunction, faceSetOption::selectionMode_, faceSetOption::selectionModeTypeNames_, faceSetOption::smAll, and faceSetOption::smVolFaceZone.

Here is the call graph for this function:

◆ setFaceSelection()

void setFaceSelection ( )
protected

Definition at line 101 of file faceSetOption.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::identity(), Foam::indent(), Foam::Info, n, and zoneID.

Here is the call graph for this function:

◆ setArea()

void setArea ( )
protected

Definition at line 74 of file faceSetOption.C.

References IOstream::defaultPrecision(), Foam::endl(), Foam::indent(), Foam::Info, Foam::reduce(), Foam::returnReduce(), and Time::timeName().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "faceSetOption"  )

◆ timeStart() [1/2]

Foam::scalar timeStart ( ) const
inlinenoexcept

Definition at line 23 of file faceSetOptionI.H.

References faceSetOption::timeStart_.

◆ duration() [1/2]

Foam::scalar duration ( ) const
inlinenoexcept

Definition at line 29 of file faceSetOptionI.H.

◆ inTimeLimits()

bool inTimeLimits ( const scalar  timeValue) const
inline

Definition at line 35 of file faceSetOptionI.H.

◆ selectionMode()

Foam::fa::faceSetOption::selectionModeType selectionMode ( ) const
inlinenoexcept

Definition at line 50 of file faceSetOptionI.H.

◆ useSubMesh()

bool useSubMesh ( ) const
inlinenoexcept

Definition at line 56 of file faceSetOptionI.H.

Referenced by limitVelocity::correct().

Here is the caller graph for this function:

◆ faceSetName()

const Foam::word & faceSetName ( ) const
inlinenoexcept

Definition at line 62 of file faceSetOptionI.H.

◆ A()

Foam::scalar A ( ) const
inlinenoexcept

Definition at line 68 of file faceSetOptionI.H.

◆ faces()

const Foam::labelList & faces ( ) const
inlinenoexcept

Definition at line 74 of file faceSetOptionI.H.

◆ timeStart() [2/2]

Foam::scalar timeStart ( scalar  val)
inlinenoexcept

Definition at line 80 of file faceSetOptionI.H.

◆ duration() [2/2]

Foam::scalar duration ( scalar  val)
inlinenoexcept

Definition at line 88 of file faceSetOptionI.H.

◆ isActive()

bool isActive ( )
virtual

Reimplemented from option.

Definition at line 198 of file faceSetOption.C.

References option::isActive().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from option.

Reimplemented in externalHeatFluxSource, jouleHeatingSource, contactHeatFluxSource, externalFileSource, and limitVelocity.

Definition at line 223 of file faceSetOption.C.

References dict, and option::read().

Referenced by limitVelocity::read().

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

Member Data Documentation

◆ selectionModeTypeNames_

const Foam::Enum< Foam::fa::faceSetOption::selectionModeType > selectionModeTypeNames_
static

Definition at line 146 of file faceSetOption.H.

Referenced by faceSetOption::setSelection().

◆ timeStart_

scalar timeStart_
protected

Definition at line 154 of file faceSetOption.H.

Referenced by faceSetOption::timeStart().

◆ duration_

scalar duration_
protected

Definition at line 157 of file faceSetOption.H.

◆ selectionMode_

selectionModeType selectionMode_
protected

Definition at line 160 of file faceSetOption.H.

Referenced by faceSetOption::setSelection().

◆ faceSetName_

word faceSetName_
protected

Definition at line 163 of file faceSetOption.H.

Referenced by faceSetOption::setSelection().

◆ faces_

labelList faces_
protected

Definition at line 166 of file faceSetOption.H.

◆ A_

scalar A_
protected

Definition at line 169 of file faceSetOption.H.

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