adjointTurbulenceModel Class Referenceabstract

Abstract base class for incompressible adjoint turbulence models (RAS, LES and laminar). More...

Inheritance diagram for adjointTurbulenceModel:
[legend]
Collaboration diagram for adjointTurbulenceModel:
[legend]

Public Member Functions

 TypeName ("adjointTurbulenceModel")
 Runtime type information. More...
 
 declareRunTimeNewSelectionTable (autoPtr, adjointTurbulenceModel, adjointTurbulenceModel,(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName),(primalVars, adjointVars, objManager, adjointTurbulenceModelName))
 
 adjointTurbulenceModel (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=typeName)
 Construct from components. More...
 
virtual ~adjointTurbulenceModel ()=default
 Destructor. More...
 
tmp< volScalarFieldnu () const
 Return the laminar viscosity. More...
 
virtual const volScalarFieldnut () const
 Return the turbulence viscosity. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
virtual tmp< volSymmTensorFielddevReff () const =0
 Return the effective stress tensor including the laminar stress. More...
 
virtual tmp< fvVectorMatrixdivDevReff (volVectorField &U) const =0
 Return the diffusion term for the momentum equation. More...
 
virtual tmp< volVectorFieldadjointMeanFlowSource ()=0
 Source term added to the adjoint mean flow due to the. More...
 
virtual void correct ()=0
 Solve the adjoint turbulence equations. More...
 
virtual bool read ()=0
 Read adjointLESProperties or adjointRASProperties dictionary. More...
 
virtual bool writeData (Ostream &) const
 Default dummy write function. More...
 
virtual void nullify ()=0
 Nullify all adjoint turbulence model fields and their old times. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTime=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const Timetime () const
 Return time. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return non-constant access to the class name read from header. More...
 
const stringnote () const
 Return the optional note. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
bool registerObject () const
 Should object created with this IOobject be registered? More...
 
boolregisterObject ()
 Should object created with this IOobject be registered? More...
 
bool globalObject () const
 Is object same for all processors? More...
 
boolglobalObject ()
 Is object same for all processors? More...
 
unsigned labelByteSize () const
 The label byte-size, possibly read from the header. More...
 
unsigned scalarByteSize () const
 The scalar byte-size, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const
 The read option. More...
 
readOptionreadOpt ()
 Non-constant access to the read option. More...
 
writeOption writeOpt () const
 The write option. More...
 
writeOptionwriteOpt ()
 Non-constant access to the write option. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &is)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header. More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class StringType >
Foam::word scopedName (StringType scope, const word &name)
 

Static Public Member Functions

static autoPtr< adjointTurbulenceModelNew (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=typeName)
 Return a reference to the selected turbulence model. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &aptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&aptr)
 
template<class Type >
static Type & store (tmp< Type > &tptr)
 
template<class Type >
static Type & store (tmp< Type > &&tptr)
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class StringType >
static word scopedName (StringType scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 

Protected Attributes

incompressibleVarsprimalVars_
 
incompressibleAdjointMeanFlowVarsadjointVars_
 
const TimerunTime_
 
const fvMeshmesh_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Abstract base class for incompressible adjoint turbulence models (RAS, LES and laminar).

Source files

Definition at line 71 of file adjointTurbulenceModel.H.

Constructor & Destructor Documentation

◆ adjointTurbulenceModel()

adjointTurbulenceModel ( incompressibleVars primalVars,
incompressibleAdjointMeanFlowVars adjointVars,
objectiveManager objManager,
const word adjointTurbulenceModelName = typeName 
)

Construct from components.

Definition at line 49 of file adjointTurbulenceModel.C.

◆ ~adjointTurbulenceModel()

virtual ~adjointTurbulenceModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "adjointTurbulenceModel"  )

Runtime type information.

◆ declareRunTimeNewSelectionTable()

declareRunTimeNewSelectionTable ( autoPtr  ,
adjointTurbulenceModel  ,
adjointTurbulenceModel  ,
(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName)  ,
(primalVars, adjointVars, objManager, adjointTurbulenceModelName)   
)

◆ New()

autoPtr< adjointTurbulenceModel > New ( incompressibleVars primalVars,
incompressibleAdjointMeanFlowVars adjointVars,
objectiveManager objManager,
const word adjointTurbulenceModelName = typeName 
)
static

Return a reference to the selected turbulence model.

Definition at line 77 of file adjointTurbulenceModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, dictionary::get(), Foam::Info, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, and incompressibleVars::U().

Here is the call graph for this function:

◆ nu()

tmp<volScalarField> nu ( ) const
inline

Return the laminar viscosity.

Definition at line 155 of file adjointTurbulenceModel.H.

References incompressibleVars::laminarTransport(), singlePhaseTransportModel::nu(), and adjointTurbulenceModel::primalVars_.

Referenced by adjointSpalartAllmaras::chi(), adjointLaminar::devReff(), adjointSpalartAllmaras::diffusionCoeffVar1(), adjointSpalartAllmaras::distanceSensitivities(), and adjointSpalartAllmaras::DnuTildaEff().

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

◆ nut()

virtual const volScalarField& nut ( ) const
inlinevirtual

Return the turbulence viscosity.

Reimplemented in adjointSpalartAllmaras.

Definition at line 161 of file adjointTurbulenceModel.H.

References adjointTurbulenceModel::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by adjointRASModel::nutJacobianTMVar1(), and adjointRASModel::nutJacobianTMVar2().

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

◆ nuEff()

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Definition at line 167 of file adjointTurbulenceModel.H.

References incompressibleVars::laminarTransport(), tmp< T >::New(), singlePhaseTransportModel::nu(), adjointTurbulenceModel::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by adjointSpalartAllmaras::devReff(), adjointSpalartAllmaras::distanceSensitivities(), adjointLaminar::divDevReff(), and adjointSpalartAllmaras::divDevReff().

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

◆ devReff()

virtual tmp<volSymmTensorField> devReff ( ) const
pure virtual

Return the effective stress tensor including the laminar stress.

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ divDevReff()

virtual tmp<fvVectorMatrix> divDevReff ( volVectorField U) const
pure virtual

Return the diffusion term for the momentum equation.

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ adjointMeanFlowSource()

virtual tmp<volVectorField> adjointMeanFlowSource ( )
pure virtual

Source term added to the adjoint mean flow due to the.

differentiation of the turbulence model

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ correct()

void correct ( )
pure virtual

Solve the adjoint turbulence equations.

Implemented in adjointSpalartAllmaras, adjointRASModel, and adjointLaminar.

Definition at line 130 of file adjointTurbulenceModel.C.

References singlePhaseTransportModel::correct(), incompressibleVars::laminarTransport(), and adjointTurbulenceModel::primalVars_.

Referenced by adjointLaminar::correct(), adjointRASModel::correct(), and adjointSpalartAllmaras::correct().

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

◆ read()

virtual bool read ( )
pure virtual

Read adjointLESProperties or adjointRASProperties dictionary.

Reimplemented from regIOobject.

Implemented in adjointSpalartAllmaras, adjointRASModel, and adjointLaminar.

◆ writeData()

virtual bool writeData ( Ostream ) const
inlinevirtual

Default dummy write function.

Implements regIOobject.

Definition at line 202 of file adjointTurbulenceModel.H.

◆ nullify()

virtual void nullify ( )
pure virtual

Nullify all adjoint turbulence model fields and their old times.

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

Member Data Documentation

◆ primalVars_

◆ adjointVars_

◆ runTime_

◆ mesh_


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