Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add lookup functionality. More...
Public Member Functions | |
TypeName ("ATCModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, ATCModel, dictionary,(const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict),(mesh, primalVars, adjointVars, dict)) | |
ATCModel (const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict) | |
Construct from components. More... | |
virtual | ~ATCModel ()=default |
Destructor. More... | |
virtual void | addATC (fvVectorMatrix &UaEqn)=0 |
Add ATC to the given matrix. More... | |
const labelList & | getZeroATCcells () |
Get the list of cells on which to zero ATC. More... | |
scalar | getExtraConvectionMultiplier () |
Get the extra convection multiplier. More... | |
scalar | getExtraDiffusionMultiplier () |
Get the extra diffusion multiplier. More... | |
const volScalarField & | getLimiter () const |
Get the list of cells on which to zero ATC. More... | |
template<class Type > | |
void | smoothFieldBasedOnCells (GeometricField< Type, fvPatchField, volMesh > &vf, const labelList &cells) |
Smooth an arbitrary field on a given list of cells. More... | |
virtual tmp< volTensorField > | getFISensitivityTerm () const =0 |
Get the FI sensitivity derivatives term coming from the ATC. More... | |
virtual bool | writeData (Ostream &) const |
Dummy writeData function required from regIOobject. More... | |
virtual void | updatePrimalBasedQuantities () |
Update quantities related with the primal fields. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=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 | registered () const noexcept |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
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... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (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 bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. 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 (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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 ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
bool | registerObject () const noexcept |
Should object created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference, return previous value. More... | |
bool | globalObject () const noexcept |
Is object same for all processors? More... | |
bool | globalObject (bool on) noexcept |
Change global-object status, return previous value. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
readOption | readOpt () const noexcept |
The read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Change the read option, return previous value. More... | |
writeOption | writeOpt () const noexcept |
The write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Change the write option, return previous value. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
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 | objectRelPath () const |
The object path relative to the root. 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... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
bool | readHeader (Istream &is) |
bool | readHeader (dictionary &headerDict, Istream &is) |
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 with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
Static Public Member Functions | |
static autoPtr< ATCModel > | New (const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict) |
Return a reference to the selected turbulence model. More... | |
static void | computeLimiter (volScalarField &limiter, const labelList &smoothCells, const label nSmooth) |
static tmp< volScalarField > | createLimiter (const fvMesh &mesh, const dictionary &dict) |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
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... | |
static word | scopedName (const std::string &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 Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Protected Member Functions | |
void | computeLimiter () |
Compute limiter based on the cells given by zeroATCcells. More... | |
void | smoothATC () |
Limit ATC field using ATClimiter_. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Attributes | |
const fvMesh & | mesh_ |
const incompressibleVars & | primalVars_ |
const incompressibleAdjointVars & | adjointVars_ |
const dictionary & | dict_ |
const scalar | extraConvection_ |
const scalar | extraDiffusion_ |
const label | nSmooth_ |
const bool | reconstructGradients_ |
word | adjointSolverName_ |
autoPtr< zeroATCcells > | zeroATCcells_ |
volScalarField | ATClimiter_ |
volVectorField | ATC_ |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 } |
Enumeration defining the read options. More... | |
enum | writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
Enumeration defining the write options. More... | |
enum | objectState : char { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add lookup functionality.
Definition at line 60 of file ATCModel.H.
ATCModel | ( | const fvMesh & | mesh, |
const incompressibleVars & | primalVars, | ||
const incompressibleAdjointVars & | adjointVars, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 61 of file ATCModel.C.
References ATCModel::computeLimiter().
|
virtualdefault |
Destructor.
|
protected |
Compute limiter based on the cells given by zeroATCcells.
Definition at line 45 of file ATCModel.C.
References ATCModel::ATClimiter_, ATCModel::computeLimiter(), ATCModel::nSmooth_, and ATCModel::zeroATCcells_.
Referenced by ATCModel::ATCModel(), ATCModel::computeLimiter(), ATCModel::createLimiter(), and ATCModel::smoothFieldBasedOnCells().
|
protected |
Limit ATC field using ATClimiter_.
Definition at line 51 of file ATCModel.C.
References ATCModel::ATC_, ATCModel::ATClimiter_, DebugInfo, Foam::endl(), and Foam::gMax().
Referenced by ATCstandard::addATC(), and ATCUaGradU::addATC().
TypeName | ( | "ATCModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
ATCModel | , | ||
dictionary | , | ||
(const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict) | , | ||
(mesh, primalVars, adjointVars, dict) | |||
) |
|
static |
Return a reference to the selected turbulence model.
Definition at line 128 of file ATCModel.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and mesh.
|
pure virtual |
Add ATC to the given matrix.
Implemented in ATCstandard, ATCUaGradU, and cancelATC.
const labelList & getZeroATCcells | ( | ) |
Get the list of cells on which to zero ATC.
Definition at line 162 of file ATCModel.C.
References ATCModel::zeroATCcells_.
scalar getExtraConvectionMultiplier | ( | ) |
Get the extra convection multiplier.
Definition at line 168 of file ATCModel.C.
References ATCModel::extraConvection_.
scalar getExtraDiffusionMultiplier | ( | ) |
Get the extra diffusion multiplier.
Definition at line 174 of file ATCModel.C.
References ATCModel::extraDiffusion_.
const volScalarField & getLimiter | ( | ) | const |
Get the list of cells on which to zero ATC.
Definition at line 180 of file ATCModel.C.
References ATCModel::ATClimiter_.
Referenced by ATCstandard::getFISensitivityTerm().
|
static |
Compute limiter based on the prescribed cells and number of smoothing iterations
Definition at line 186 of file ATCModel.C.
References Foam::fvc::average(), cells, localMin< Type >::interpolate(), Foam::limiter(), mesh, and Foam::Zero.
|
static |
Return a limiter based on given cells. For use with classes other than ATC which employ the same smoothing mechanism
Definition at line 220 of file ATCModel.C.
References ATCModel::computeLimiter(), dict, Foam::dimless, dictionary::getOrDefault(), Foam::limiter(), mesh, Time::New(), IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), Time::timeName(), and zeroCells().
Referenced by adjointSpalartAllmaras::allocateMask().
void smoothFieldBasedOnCells | ( | GeometricField< Type, fvPatchField, volMesh > & | vf, |
const labelList & | cells | ||
) |
Smooth an arbitrary field on a given list of cells.
Definition at line 36 of file ATCModelTemplates.C.
References cells, ATCModel::computeLimiter(), Foam::dimless, Foam::limiter(), ATCModel::mesh_, IOobject::name(), IOobject::NO_READ, IOobject::NO_WRITE, ATCModel::nSmooth_, fvMesh::time(), and Time::timeName().
|
pure virtual |
Get the FI sensitivity derivatives term coming from the ATC.
Implemented in ATCstandard, ATCUaGradU, and cancelATC.
Dummy writeData function required from regIOobject.
Implements regIOobject.
Definition at line 255 of file ATCModel.C.
|
virtual |
Update quantities related with the primal fields.
Reimplemented in ATCstandard.
Definition at line 262 of file ATCModel.C.
|
protected |
Definition at line 79 of file ATCModel.H.
Referenced by ATCstandard::getFISensitivityTerm(), ATCUaGradU::getFISensitivityTerm(), cancelATC::getFISensitivityTerm(), and ATCModel::smoothFieldBasedOnCells().
|
protected |
Definition at line 80 of file ATCModel.H.
Referenced by ATCstandard::addATC(), ATCUaGradU::addATC(), ATCstandard::getFISensitivityTerm(), ATCUaGradU::getFISensitivityTerm(), and ATCstandard::updatePrimalBasedQuantities().
|
protected |
Definition at line 81 of file ATCModel.H.
Referenced by ATCstandard::addATC(), ATCUaGradU::addATC(), ATCstandard::getFISensitivityTerm(), and ATCUaGradU::getFISensitivityTerm().
|
protected |
Definition at line 84 of file ATCModel.H.
|
protected |
Definition at line 85 of file ATCModel.H.
Referenced by ATCstandard::addATC(), ATCUaGradU::addATC(), and ATCModel::getExtraConvectionMultiplier().
|
protected |
Definition at line 86 of file ATCModel.H.
Referenced by ATCModel::getExtraDiffusionMultiplier().
|
protected |
Definition at line 87 of file ATCModel.H.
Referenced by ATCModel::computeLimiter(), and ATCModel::smoothFieldBasedOnCells().
|
protected |
Definition at line 88 of file ATCModel.H.
Referenced by ATCUaGradU::addATC(), and ATCstandard::updatePrimalBasedQuantities().
|
protected |
Definition at line 89 of file ATCModel.H.
|
protected |
Definition at line 90 of file ATCModel.H.
Referenced by ATCModel::computeLimiter(), and ATCModel::getZeroATCcells().
|
protected |
Definition at line 91 of file ATCModel.H.
Referenced by ATCModel::computeLimiter(), ATCModel::getLimiter(), and ATCModel::smoothATC().
|
protected |
Definition at line 92 of file ATCModel.H.
Referenced by ATCstandard::addATC(), ATCUaGradU::addATC(), and ATCModel::smoothATC().