Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
optionList Class Reference

List of finite volume options. More...

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

Public Member Functions

 TypeName ("optionList")
 
 optionList (const fvMesh &mesh)
 
 optionList (const fvMesh &mesh, const dictionary &dict)
 
virtual ~optionList ()=default
 
void reset (const dictionary &dict)
 
bool appliesToField (const word &fieldName) const
 
template<class Type >
tmp< fvMatrix< Type > > operator() (GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const volScalarField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const geometricOneField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > operator() (const geometricOneField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
tmp< fvMatrix< Type > > d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
 
template<class Type >
void constrain (fvMatrix< Type > &eqn)
 
template<class Type >
void correct (GeometricField< Type, fvPatchField, volMesh > &field)
 
template<class Type >
void postProcessSens (Field< Type > &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual bool read (const dictionary &dict)
 
virtual bool writeData (Ostream &os) const
 
- Public Member Functions inherited from PtrList< fv::option >
constexpr PtrList () noexcept
 
 PtrList (const label len)
 
 PtrList (const PtrList< T > &list)
 
 PtrList (PtrList< T > &&list)
 
 PtrList (UList< T * > &list)
 
 PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
 
 PtrList (PtrList< T > &list, bool reuse)
 
 PtrList (const SLPtrList< T > &list)
 
 PtrList (Istream &is, const INew &inew)
 
 PtrList (Istream &is)
 
 PtrList (PtrList< T > &list, bool reuse)
 
 PtrList (const SLPtrList< T > &list)
 
constexpr PtrList () noexcept
 
 PtrList (const label len)
 
 PtrList (const PtrList< T > &list)
 
 PtrList (PtrList< T > &&list)
 
 PtrList (UList< T * > &list)
 
 PtrList (Istream &is)
 
 ~PtrList ()
 
PtrList< T > clone (Args &&... args) const
 
Foam::PtrList< T > clone (Args &&... args) const
 
const T * set (const label i) const
 
autoPtr< T > set (const label i, T *ptr)
 
autoPtr< T > set (const label i, autoPtr< T > &ptr)
 
autoPtr< T > set (const label i, autoPtr< T > &&ptr)
 
autoPtr< T > set (const label i, std::unique_ptr< T > &&ptr)
 
autoPtr< T > set (const label i, const refPtr< T > &ptr)
 
autoPtr< T > set (const label i, const tmp< T > &ptr)
 
void clear ()
 
void resize (const label newLen)
 
void setSize (const label newLen)
 
void emplace_append (Args &&... args)
 
void append (T *ptr)
 
void append (autoPtr< T > &ptr)
 
void append (autoPtr< T > &&ptr)
 
void append (std::unique_ptr< T > &&ptr)
 
void append (const refPtr< T > &ptr)
 
void append (const tmp< T > &ptr)
 
autoPtr< T > emplace (const label i, Args &&... args)
 
Foam::autoPtr< T > emplace (const label i, Args &&... args)
 
autoPtr< T > release (const label i)
 
void transfer (PtrList< T > &list)
 
void operator= (const PtrList< T > &list)
 
void operator= (PtrList< T > &&list)
 

Protected Member Functions

bool readOptions (const dictionary &dict)
 
void checkApplied () const
 
template<class Type >
tmp< fvMatrix< Type > > source (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds)
 
 optionList (const optionList &)=delete
 
void operator= (const optionList &)=delete
 
- Protected Member Functions inherited from PtrList< fv::option >
void readIstream (Istream &is, const INew &inew)
 
void free ()
 

Static Protected Member Functions

static const dictionary & optionsDict (const dictionary &dict)
 

Protected Attributes

const fvMesh & mesh_
 
label checkTimeIndex_
 

Friends

Ostream & operator<< (Ostream &os, const optionList &options)
 

Detailed Description

List of finite volume options.

SourceFile optionList.C

Definition at line 63 of file fvOptionList.H.

Constructor & Destructor Documentation

◆ optionList() [1/3]

optionList ( const optionList &  )
protecteddelete

Referenced by kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficients().

Here is the caller graph for this function:

◆ optionList() [2/3]

optionList ( const fvMesh &  mesh)
explicit

Definition at line 87 of file fvOptionList.C.

◆ optionList() [3/3]

optionList ( const fvMesh &  mesh,
const dictionary &  dict 
)

Definition at line 77 of file fvOptionList.C.

References dict, optionList::optionsDict(), and optionList::reset().

Here is the call graph for this function:

◆ ~optionList()

virtual ~optionList ( )
virtualdefault

Member Function Documentation

◆ optionsDict()

const Foam::dictionary & optionsDict ( const dictionary &  dict)
staticprotected

Definition at line 39 of file fvOptionList.C.

References dict.

Referenced by optionList::optionList().

Here is the caller graph for this function:

◆ readOptions()

bool readOptions ( const dictionary &  dict)
protected

Definition at line 49 of file fvOptionList.C.

References optionList::checkTimeIndex_, dict, optionList::mesh_, option::name(), option::read(), fvMesh::time(), and TimeState::timeIndex().

Here is the call graph for this function:

◆ checkApplied()

void checkApplied ( ) const
protected

Definition at line 63 of file fvOptionList.C.

References option::checkApplied().

Referenced by optionList::constrain().

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

◆ source()

tmp<fvMatrix<Type> > source ( GeometricField< Type, fvPatchField, volMesh > &  field,
const word &  fieldName,
const dimensionSet &  ds 
)
protected

Referenced by optionList::constrain().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const optionList &  )
protecteddelete

◆ TypeName()

TypeName ( "optionList"  )

◆ reset()

void reset ( const dictionary &  dict)

Definition at line 97 of file fvOptionList.C.

References Foam::BitOps::count(), dict, Foam::name(), option::New(), resize(), and Foam::BitOps::set().

Referenced by optionList::optionList().

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

◆ appliesToField()

bool appliesToField ( const word &  fieldName) const

Definition at line 129 of file fvOptionList.C.

References option::applyToField().

Here is the call graph for this function:

◆ operator()() [1/9]

tmp<fvMatrix<Type> > operator() ( GeometricField< Type, fvPatchField, volMesh > &  field)

◆ operator()() [2/9]

tmp<fvMatrix<Type> > operator() ( GeometricField< Type, fvPatchField, volMesh > &  field,
const word &  fieldName 
)

◆ operator()() [3/9]

tmp<fvMatrix<Type> > operator() ( const volScalarField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field 
)

◆ operator()() [4/9]

tmp<fvMatrix<Type> > operator() ( const volScalarField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field,
const word &  fieldName 
)

◆ operator()() [5/9]

tmp<fvMatrix<Type> > operator() ( const volScalarField &  alpha,
const volScalarField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field 
)

◆ operator()() [6/9]

tmp<fvMatrix<Type> > operator() ( const volScalarField &  alpha,
const volScalarField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field,
const word &  fieldName 
)

◆ operator()() [7/9]

tmp<fvMatrix<Type> > operator() ( const volScalarField &  alpha,
const geometricOneField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field 
)

◆ operator()() [8/9]

tmp<fvMatrix<Type> > operator() ( const geometricOneField &  alpha,
const volScalarField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field 
)

◆ operator()() [9/9]

tmp<fvMatrix<Type> > operator() ( const geometricOneField &  alpha,
const geometricOneField &  rho,
GeometricField< Type, fvPatchField, volMesh > &  field 
)

◆ d2dt2() [1/2]

tmp<fvMatrix<Type> > d2dt2 ( GeometricField< Type, fvPatchField, volMesh > &  field)

◆ d2dt2() [2/2]

tmp<fvMatrix<Type> > d2dt2 ( GeometricField< Type, fvPatchField, volMesh > &  field,
const word &  fieldName 
)

◆ constrain()

void constrain ( fvMatrix< Type > &  eqn)

Definition at line 307 of file fvOptionListTemplates.C.

References addProfiling, optionList::checkApplied(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, fvMatrix::psi(), and optionList::source().

Referenced by kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), incompressiblePrimalSolver::correctBoundaryConditions(), simple::mainIter(), adjointSimple::mainIter(), velocityComponentLaplacianFvMotionSolver::solve(), velocityLaplacianFvMotionSolver::solve(), displacementComponentLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), and surfaceAlignedSBRStressFvMotionSolver::solve().

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

◆ correct()

void correct ( GeometricField< Type, fvPatchField, volMesh > &  field)

Definition at line 348 of file fvOptionListTemplates.C.

References addProfiling, option::applyToField(), option::correct(), Foam::expressions::patchExpr::debug, Foam::endl(), field(), Foam::Info, option::isActive(), option::name(), and option::setApplied().

Referenced by kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), dynamicLagrangian< BasicTurbulenceModel >::correctNut(), kOmega< BasicTurbulenceModel >::correctNut(), kEqn< BasicTurbulenceModel >::correctNut(), WALE< BasicTurbulenceModel >::correctNut(), continuousGasKEpsilon< BasicTurbulenceModel >::correctNut(), DeardorffDiffStress< BasicTurbulenceModel >::correctNut(), SmagorinskyZhang< BasicTurbulenceModel >::correctNut(), realizableKE< BasicTurbulenceModel >::correctNut(), NicenoKEqn< BasicTurbulenceModel >::correctNut(), Smagorinsky< BasicTurbulenceModel >::correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correctNut(), RNGkEpsilon< BasicTurbulenceModel >::correctNut(), LaunderSharmaKE< BasicTurbulenceModel >::correctNut(), dynamicKEqn< BasicTurbulenceModel >::correctNut(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::correctNut(), SSG< BasicTurbulenceModel >::correctNut(), mixtureKEpsilon< BasicTurbulenceModel >::correctNut(), LRR< BasicTurbulenceModel >::correctNut(), kOmegaSSTSato< BasicTurbulenceModel >::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), SpalartAllmaras< BasicTurbulenceModel >::correctNut(), kEpsilonPhitF< BasicTurbulenceModel >::correctNut(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correctNut(), kL< BasicTurbulenceModel >::correctNut(), simple::mainIter(), adjointSimple::mainIter(), velocityComponentLaplacianFvMotionSolver::solve(), velocityLaplacianFvMotionSolver::solve(), displacementComponentLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), and surfaceAlignedSBRStressFvMotionSolver::solve().

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

◆ postProcessSens()

void postProcessSens ( Field< Type > &  sensField,
const word &  fieldName = word::null,
const word &  designVariablesName = word::null 
)

Definition at line 391 of file fvOptionListTemplates.C.

References addProfiling, option::applyToField(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, option::isActive(), option::name(), and option::postProcessSens().

Referenced by FIBase::accumulateIntegrand(), and adjointSensitivity::adjointMeshMovementSource().

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

◆ read()

bool read ( const dictionary &  dict)
virtual

Definition at line 145 of file fvOptionList.C.

References dict.

Referenced by options::read().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream &  os) const
virtual

Definition at line 151 of file fvOptionList.C.

References Foam::nl, os(), option::writeData(), option::writeFooter(), and option::writeHeader().

Referenced by Foam::operator<<().

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

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const optionList &  options 
)
friend

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Definition at line 72 of file fvOptionList.H.

Referenced by optionList::readOptions().

◆ checkTimeIndex_

label checkTimeIndex_
protected

Definition at line 75 of file fvOptionList.H.

Referenced by optionList::readOptions().

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