List of finite volume options. More...
Public Member Functions | |
| TypeName ("optionList") | |
| Runtime type information. More... | |
| optionList (const fvMesh &mesh) | |
| Construct null. More... | |
| optionList (const fvMesh &mesh, const dictionary &dict) | |
| Construct from mesh and dictionary. More... | |
| virtual | ~optionList () |
| Destructor. More... | |
| void | reset (const dictionary &dict) |
| Reset the source list. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| Return source for equation with specified name. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| Return source for equation with specified name. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| Return source for equation with specified name. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const volScalarField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const geometricOneField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | operator() (const geometricOneField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| Return source for equation. More... | |
| template<class Type > | |
| void | constrain (fvMatrix< Type > &eqn) |
| Apply constraints to equation. More... | |
| template<class Type > | |
| void | correct (GeometricField< Type, fvPatchField, volMesh > &field) |
| Apply correction to field. More... | |
| virtual bool | read (const dictionary &dict) |
| Read dictionary. More... | |
| virtual bool | writeData (Ostream &os) const |
| Write data to Ostream. More... | |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (GeometricField< Type, fvPatchField, volMesh > &field) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const geometricOneField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const volScalarField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
| template<class Type > | |
| Foam::tmp< Foam::fvMatrix< Type > > | operator() (const geometricOneField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field) |
 Public Member Functions inherited from PtrList< option > | |
| PtrList () | |
| Null Constructor. More... | |
| PtrList (const label) | |
| Construct with size specified. More... | |
| PtrList (const PtrList< option > &) | |
| Copy constructor. More... | |
| PtrList (const PtrList< option > &, const CloneArg &) | |
| Copy constructor with additional argument for clone. More... | |
| PtrList (const Xfer< PtrList< option >> &) | |
| Construct by transferring the parameter contents. More... | |
| PtrList (PtrList< option > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< option > &) | |
| Construct as copy of SLPtrList<T> More... | |
| PtrList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. More... | |
| void | setSize (const label) |
| Reset size of PtrList. If extending the PtrList, new entries are. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | clear () |
| Clear the PtrList, i.e. set size to zero deleting all the. More... | |
| void | append (option *) |
| Append an element at the end of the list. More... | |
| void | append (const autoPtr< option > &) |
| void | append (const tmp< option > &) |
| void | transfer (PtrList< option > &) |
| Transfer the contents of the argument PtrList into this PtrList. More... | |
| Xfer< PtrList< option > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| autoPtr< option > | set (const label, option *) |
| Set element to given T* and return old element (can be nullptr) More... | |
| autoPtr< option > | set (const label, const autoPtr< option > &) |
| Set element to given autoPtr<T> and return old element. More... | |
| autoPtr< option > | set (const label, const tmp< option > &) |
| Set element to given tmp<T> and return old element. More... | |
| void | reorder (const labelUList &) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | operator= (const PtrList< option > &) |
| Assignment. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| UPtrList () | |
| Null Constructor. More... | |
| UPtrList (const label) | |
| Construct with size specified. More... | |
| UPtrList (const Xfer< UPtrList< T >> &) | |
| Construct by transferring the parameter contents. More... | |
| UPtrList (UPtrList< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| label | size () const |
| Return the number of elements in the UPtrList. More... | |
| bool | empty () const |
| Return true if the UPtrList is empty (ie, size() is zero) More... | |
| T & | first () |
| Return reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| void | setSize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | resize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | clear () |
| Clear the UPtrList, i.e. set size to zero. More... | |
| void | transfer (UPtrList< T > &) |
| Transfer the contents of the argument UPtrList into this. More... | |
| Xfer< UPtrList< T > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| T * | set (const label, T *) |
| Set element. Return old element (can be nullptr). More... | |
| void | reorder (const labelUList &) |
| Reorders elements. Ordering does not have to be done in. More... | |
| const T & | operator[] (const label) const |
| Return element const reference. More... | |
| T & | operator[] (const label) |
| Return element reference. More... | |
| const T * | operator() (const label) const |
| Return element const pointer. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UPtrList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UPtrList. More... | |
| const_iterator | cbegin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | cend () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| const_iterator | begin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | end () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
Protected Member Functions | |
| const dictionary & | optionsDict (const dictionary &dict) const |
| Return the "options" sub-dictionary if present otherwise return dict. More... | |
| bool | readOptions (const dictionary &dict) |
| Read options dictionary. More... | |
| void | checkApplied () const |
| Check that all sources have been applied. More... | |
| optionList (const optionList &) | |
| Disallow default bitwise copy construct. More... | |
| void | operator= (const optionList &) |
| Disallow default bitwise assignment. More... | |
| Protected Member Functions inherited from PtrList< option > | |
| void | read (Istream &, const INew &inewt) |
| Read from Istream using given Istream constructor class. More... | |
Protected Attributes | |
| const fvMesh & | mesh_ |
| Reference to the mesh database. More... | |
| label | checkTimeIndex_ |
| Time index to check that all defined sources have been applied. More... | |
Friends | |
| Ostream & | operator<< (Ostream &os, const optionList &options) |
| Ostream operator. More... | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the UPtrList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into UPtrList::value_type objects. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into constant UPtrList::value_type. More... | |
List of finite volume options.
Definition at line 64 of file fvOptionList.H.
|
protected |
Disallow default bitwise copy construct.
| optionList | ( | const fvMesh & | mesh | ) |
Construct null.
Definition at line 98 of file fvOptionList.C.
| optionList | ( | const fvMesh & | mesh, |
| const dictionary & | dict | ||
| ) |
Construct from mesh and dictionary.
Definition at line 88 of file fvOptionList.C.
References optionList::optionsDict(), and optionList::reset().
|
inlinevirtual |
Destructor.
Definition at line 113 of file fvOptionList.H.
References Foam::constant::atomic::alpha, constrain(), correct, dict, Foam::read(), rho, and writeData().
|
protected |
Return the "options" sub-dictionary if present otherwise return dict.
Definition at line 43 of file fvOptionList.C.
References dict, dictionary::found(), and dictionary::subDict().
Referenced by optionList::optionList(), and optionList::read().
|
protected |
Read options dictionary.
Definition at line 58 of file fvOptionList.C.
References forAll, option::name(), option::read(), and dictionary::subDict().
Referenced by optionList::read().
|
protected |
Check that all sources have been applied.
Definition at line 73 of file fvOptionList.C.
References option::checkApplied(), and forAll.
Referenced by optionList::constrain().
|
protected |
Disallow default bitwise assignment.
| TypeName | ( | "optionList" | ) |
Runtime type information.
| void reset | ( | const dictionary & | dict | ) |
Reset the source list.
Definition at line 108 of file fvOptionList.C.
References forAllConstIter(), optionList::mesh_, Foam::name(), option::New(), and PtrList< option >::setSize().
Referenced by optionList::optionList().
| tmp<fvMatrix<Type> > operator() | ( | GeometricField< Type, fvPatchField, volMesh > & | field | ) |
Return source for equation.
| tmp<fvMatrix<Type> > operator() | ( | GeometricField< Type, fvPatchField, volMesh > & | field, |
| const word & | fieldName | ||
| ) |
Return source for equation with specified name.
| tmp<fvMatrix<Type> > operator() | ( | const volScalarField & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Return source for equation.
| tmp<fvMatrix<Type> > operator() | ( | const volScalarField & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | field, | ||
| const word & | fieldName | ||
| ) |
Return source for equation with specified name.
| tmp<fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Return source for equation.
| tmp<fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field, | ||
| const word & | fieldName | ||
| ) |
Return source for equation with specified name.
| tmp<fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const geometricOneField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Return source for equation.
| tmp<fvMatrix<Type> > operator() | ( | const geometricOneField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Return source for equation.
| tmp<fvMatrix<Type> > operator() | ( | const geometricOneField & | alpha, |
| const geometricOneField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Return source for equation.
| void constrain | ( | fvMatrix< Type > & | eqn | ) |
Apply constraints to equation.
Definition at line 246 of file fvOptionListTemplates.C.
References option::applyToField(), optionList::checkApplied(), option::constrain(), optionList::correct(), Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), UPtrList< T >::operator[](), fvMatrix< Type >::psi(), and option::setApplied().
Referenced by DeardorffDiffStress< BasicTurbulenceModel >::correct(), Maxwell< BasicTurbulenceModel >::correct(), dynamicLagrangian< BasicTurbulenceModel >::correct(), kEqn< BasicTurbulenceModel >::correct(), dynamicKEqn< BasicTurbulenceModel >::correct(), SSG< BasicTurbulenceModel >::correct(), SpalartAllmaras< BasicTurbulenceModel >::correct(), kOmega< BasicTurbulenceModel >::correct(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correct(), realizableKE< BasicTurbulenceModel >::correct(), RNGkEpsilon< BasicTurbulenceModel >::correct(), LaunderSharmaKE< BasicTurbulenceModel >::correct(), SpalartAllmarasDES< BasicTurbulenceModel >::correct(), LRR< BasicTurbulenceModel >::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), v2f< BasicTurbulenceModel >::correct(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::correct(), and kOmegaSSTLM< BasicTurbulenceModel >::correctReThetatGammaInt().
| void correct | ( | GeometricField< Type, fvPatchField, volMesh > & | field | ) |
Apply correction to field.
Definition at line 277 of file fvOptionListTemplates.C.
References option::applyToField(), option::correct(), Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), IOobject::name(), UPtrList< T >::operator[](), and option::setApplied().
Referenced by optionList::constrain(), DeardorffDiffStress< BasicTurbulenceModel >::correct(), Maxwell< BasicTurbulenceModel >::correct(), dynamicLagrangian< BasicTurbulenceModel >::correct(), kEqn< BasicTurbulenceModel >::correct(), dynamicKEqn< BasicTurbulenceModel >::correct(), SSG< BasicTurbulenceModel >::correct(), SpalartAllmaras< BasicTurbulenceModel >::correct(), realizableKE< BasicTurbulenceModel >::correct(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correct(), kOmega< BasicTurbulenceModel >::correct(), RNGkEpsilon< BasicTurbulenceModel >::correct(), LaunderSharmaKE< BasicTurbulenceModel >::correct(), SpalartAllmarasDES< BasicTurbulenceModel >::correct(), LRR< BasicTurbulenceModel >::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), v2f< BasicTurbulenceModel >::correct(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::correct(), dynamicLagrangian< BasicTurbulenceModel >::correctNut(), kEqn< BasicTurbulenceModel >::correctNut(), kOmega< BasicTurbulenceModel >::correctNut(), WALE< BasicTurbulenceModel >::correctNut(), continuousGasKEpsilon< BasicTurbulenceModel >::correctNut(), DeardorffDiffStress< BasicTurbulenceModel >::correctNut(), SmagorinskyZhang< BasicTurbulenceModel >::correctNut(), realizableKE< BasicTurbulenceModel >::correctNut(), Smagorinsky< BasicTurbulenceModel >::correctNut(), NicenoKEqn< BasicTurbulenceModel >::correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correctNut(), RNGkEpsilon< BasicTurbulenceModel >::correctNut(), LaunderSharmaKE< BasicTurbulenceModel >::correctNut(), dynamicKEqn< BasicTurbulenceModel >::correctNut(), SSG< BasicTurbulenceModel >::correctNut(), mixtureKEpsilon< BasicTurbulenceModel >::correctNut(), LRR< BasicTurbulenceModel >::correctNut(), SpalartAllmaras< BasicTurbulenceModel >::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), kOmegaSSTSato< BasicTurbulenceModel >::correctNut(), v2f< BasicTurbulenceModel >::correctNut(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::correctNut(), and kOmegaSSTLM< BasicTurbulenceModel >::correctReThetatGammaInt().
|
virtual |
Read dictionary.
Definition at line 139 of file fvOptionList.C.
References optionList::optionsDict(), and optionList::readOptions().
Referenced by options::read(), and options::~options().
|
virtual |
Write data to Ostream.
Definition at line 145 of file fvOptionList.C.
References forAll, IOstream::good(), Foam::nl, and UPtrList< T >::operator[]().
Referenced by Foam::operator<<().
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | GeometricField< Type, fvPatchField, volMesh > & | field | ) |
Definition at line 30 of file fvOptionListTemplates.C.
References UPtrList< T >::operator.
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | GeometricField< Type, fvPatchField, volMesh > & | field, |
| const word & | fieldName | ||
| ) |
Definition at line 40 of file fvOptionListTemplates.C.
References option::addSup(), option::applyToField(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVolume, Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), UPtrList< T >::operator, tmp< T >::ref(), and option::setApplied().
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const volScalarField & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Definition at line 81 of file fvOptionListTemplates.C.
References IOobject::name(), and UPtrList< T >::operator.
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const volScalarField & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | field, | ||
| const word & | fieldName | ||
| ) |
Definition at line 92 of file fvOptionListTemplates.C.
References option::addSup(), option::applyToField(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVolume, Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), UPtrList< T >::operator, and option::setApplied().
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Definition at line 137 of file fvOptionListTemplates.C.
References IOobject::name(), and UPtrList< T >::operator.
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field, | ||
| const word & | fieldName | ||
| ) |
Definition at line 149 of file fvOptionListTemplates.C.
References option::addSup(), option::applyToField(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVolume, Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), UPtrList< T >::operator, and option::setApplied().
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const geometricOneField & | alpha, |
| const geometricOneField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Definition at line 196 of file fvOptionListTemplates.C.
References IOobject::name(), and UPtrList< T >::operator.
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const volScalarField & | alpha, |
| const geometricOneField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Definition at line 208 of file fvOptionListTemplates.C.
References Foam::dimless, IOobject::name(), and UPtrList< T >::operator.
| Foam::tmp<Foam::fvMatrix<Type> > operator() | ( | const geometricOneField & | alpha, |
| const volScalarField & | rho, | ||
| GeometricField< Type, fvPatchField, volMesh > & | field | ||
| ) |
Definition at line 235 of file fvOptionListTemplates.C.
References IOobject::name().
|
friend |
Ostream operator.
|
protected |
Reference to the mesh database.
Definition at line 73 of file fvOptionList.H.
Referenced by optionList::reset().
|
protected |
Time index to check that all defined sources have been applied.
Definition at line 76 of file fvOptionList.H.
1.8.13
