Solution of the adjoint PDEs for incompressible, steady-state flows. More...
Public Member Functions | |
TypeName ("adjointSimple") | |
Run-time type information. More... | |
adjointSimple (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) | |
Construct from mesh and dictionary. More... | |
virtual | ~adjointSimple ()=default |
Destructor. More... | |
virtual bool | readDict (const dictionary &dict) |
Read dict if updated. More... | |
virtual void | solveIter () |
Execute one iteration of the solution algorithm. More... | |
virtual void | preIter () |
Steps to be executed before each main SIMPLE iteration. More... | |
virtual void | mainIter () |
The main SIMPLE iter. More... | |
virtual void | postIter () |
Steps to be executed before each main SIMPLE iteration. More... | |
virtual void | solve () |
Main control loop. More... | |
virtual bool | loop () |
Looper (advances iters, time step) More... | |
virtual void | preLoop () |
Functions to be called before loop. More... | |
virtual void | computeObjectiveSensitivities () |
Compute sensitivities of the underlaying objectives. More... | |
virtual const scalarField & | getObjectiveSensitivities () |
Grab a reference to the computed sensitivities. More... | |
virtual void | clearSensitivities () |
Clears the sensitivity field known by the adjoint solver and zeros sensitivities constituents. More... | |
virtual sensitivity & | getSensitivityBase () |
Return the base sensitivity object. More... | |
virtual void | addMomentumSource (fvVectorMatrix &matrix) |
Source terms for the momentum equations. More... | |
virtual void | addPressureSource (fvScalarMatrix &matrix) |
Source terms for the continuity equation. More... | |
virtual void | updatePrimalBasedQuantities () |
Update primal based quantities related to the objective functions. More... | |
virtual bool | writeData (Ostream &os) const |
Write average iteration. More... | |
Public Member Functions inherited from incompressibleAdjointSolver | |
TypeName ("incompressible") | |
Run-time type information. More... | |
declareRunTimeSelectionTable (autoPtr, incompressibleAdjointSolver, dictionary,(fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName),(mesh, managerType, dict, primalSolverName)) | |
incompressibleAdjointSolver (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) | |
Construct from mesh and dictionary. More... | |
virtual | ~incompressibleAdjointSolver ()=default |
Destructor. More... | |
virtual bool | useSolverNameForFields () const |
Should solver name be appended to fields. More... | |
const incompressibleVars & | getPrimalVars () const |
Access to the incompressible primal variables set. More... | |
virtual const incompressibleAdjointVars & | getAdjointVars () const |
Access to the incompressible adjoint variables set. More... | |
virtual incompressibleAdjointVars & | getAdjointVars () |
Access to the incompressible adjoint variables set. More... | |
const autoPtr< ATCModel > & | getATCModel () const |
Access to the ATC model. More... | |
autoPtr< ATCModel > & | getATCModel () |
Access to the ATC model. More... | |
virtual tmp< volTensorField > | computeGradDxDbMultiplier () |
Compute the multiplier for grad(dxdb) More... | |
virtual void | additionalSensitivityMapTerms (boundaryVectorField &sensitivityMap, const labelHashSet &patchIDs, const scalar dt) |
Terms to be added to the sensitivity map, depending on the adjoint solver. More... | |
virtual bool | write (const bool valid=true) const |
In case of multi-point runs with turbulent flows, output dummy turbulence fields with the base names, to allow continuation. More... | |
virtual bool | writeNow () const |
In case of multi-point runs with turbulent flows, output dummy turbulence fields with the base names, to allow continuation. More... | |
Public Member Functions inherited from adjointSolver | |
TypeName ("adjointSolver") | |
Run-time type information. More... | |
declareRunTimeNewSelectionTable (autoPtr, adjointSolver, adjointSolver,(fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName),(mesh, managerType, dict, primalSolverName)) | |
adjointSolver (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) | |
Construct from mesh, dictionary, and primal solver name. More... | |
virtual | ~adjointSolver ()=default |
Destructor. More... | |
const word & | primalSolverName () const |
Return the primal solver name. More... | |
const primalSolver & | getPrimalSolver () const |
Return a const-reference to the primal solver corresponding to this adjoint solver. More... | |
primalSolver & | getPrimalSolver () |
Return a non const-reference to the primal solver corresponding to this adjoint solver. More... | |
const objectiveManager & | getObjectiveManager () const |
Return a const reference to the objective manager. More... | |
objectiveManager & | getObjectiveManager () |
Return a reference to the objective manager. More... | |
virtual void | postLoop () |
Functions to be called after loop. More... | |
virtual bool | isConstraint () |
Is the solving referring to a constraint. More... | |
Public Member Functions inherited from solver | |
TypeName ("solver") | |
Run-time type information. More... | |
solver (fvMesh &mesh, const word &managerType, const dictionary &dict) | |
Construct from mesh and dictionary. More... | |
virtual | ~solver () |
Destructor. More... | |
const fvMesh & | mesh () const |
Return the solver mesh. More... | |
const word & | solverName () const |
Return the solver name. More... | |
virtual bool | active () |
Return state of solver. More... | |
virtual const dictionary & | dict () const |
Return the solver dictionary. More... | |
const variablesSet & | getVariablesSet () const |
Return constant reference to variableSet used by the solver. More... | |
variablesSet & | getVariablesSet () |
Return non-constant reference to variableSet used by the solver. More... | |
virtual void | restoreInitValues () |
Restore initial field values if necessary. More... | |
void | updateOptTypeSource (const autoPtr< volScalarField > &optSourcePtr) |
Update source term related to optimisationType. More... | |
template<class Type > | |
void | solveWithArgs (Type &type, List< void(Type::*)()> &funcs) |
Main control loop. More... | |
template<class Type > | |
void | addOptimisationTypeSource (fvMatrix< Type > &matrix) const |
Add source from optimisationType to underlaying equation. More... | |
Public Member Functions inherited from localIOdictionary | |
localIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
Construct given an IOobject and optional fallback dictionary content. More... | |
localIOdictionary (const IOobject &io, const dictionary &dict) | |
Construct given an IOobject and fallback dictionary content. More... | |
localIOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr) | |
Construct given an IOobject, wanted typeName and optional fallback dictionary content. More... | |
localIOdictionary (const IOobject &io, Istream &is) | |
Construct given an IOobject and Istream. More... | |
virtual | ~localIOdictionary ()=default |
Destructor. More... | |
virtual bool | global () const |
Is object global. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
Public Member Functions inherited from baseIOdictionary | |
TypeName ("dictionary") | |
Declare type-name, virtual type (with debug switch) More... | |
baseIOdictionary (const baseIOdictionary &)=default | |
Copy construct. More... | |
baseIOdictionary (baseIOdictionary &&)=default | |
Move construct. More... | |
virtual | ~baseIOdictionary ()=default |
Destructor. More... | |
baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
Construct given an IOobject and optional fallback dictionary content (ununsed) More... | |
baseIOdictionary (const IOobject &io, const dictionary &dict) | |
Construct given an IOobject and fallback dictionary content (ununsed) More... | |
baseIOdictionary (const IOobject &io, Istream &is) | |
Construct given an IOobject and Istream (ununsed) More... | |
const word & | name () const |
Name function is needed to disambiguate those inherited from regIOobject and dictionary. More... | |
virtual bool | readData (Istream &) |
The readData function required by regIOobject read operation. More... | |
void | operator= (const baseIOdictionary &rhs) |
Copy assignment of dictionary entries (leave regIOobject untouched) More... | |
void | operator= (const dictionary &rhs) |
Copy assignment of dictionary entries. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
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 |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
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... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool readOnProc=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. 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 |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) 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, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. 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 noexcept |
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... | |
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... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. 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... | |
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 |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. 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 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 |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) 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) |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, register, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required(ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. 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... | |
Public Member Functions inherited from dictionary | |
ClassName ("dictionary") | |
dictionary () | |
Default construct, a top-level empty dictionary. More... | |
dictionary (const fileName &name) | |
Construct top-level empty dictionary with given name. More... | |
dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false) | |
Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header. More... | |
dictionary (Istream &is) | |
Construct top-level dictionary from Istream, reading entries until EOF. Discards the header. More... | |
dictionary (Istream &is, bool keepHeader) | |
Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header. More... | |
dictionary (const dictionary &parentDict, const dictionary &dict) | |
Copy construct given the parent dictionary. More... | |
dictionary (const dictionary &dict) | |
Copy construct top-level dictionary. More... | |
dictionary (const dictionary *dict) | |
Construct top-level dictionary as copy from pointer to dictionary. More... | |
dictionary (const dictionary &parentDict, dictionary &&dict) | |
Move construct for given parent dictionary. More... | |
dictionary (dictionary &&dict) | |
Move construct top-level dictionary. More... | |
autoPtr< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const fileName & | name () const noexcept |
The dictionary name. More... | |
fileName & | name () noexcept |
The dictionary name for modification (use with caution). More... | |
word | dictName () const |
The local dictionary name (final part of scoped name) More... | |
fileName | relativeName (const bool caseTag=false) const |
The dictionary name relative to the case. More... | |
bool | isNullDict () const noexcept |
The dictionary is actually dictionary::null (root dictionary) More... | |
const dictionary & | parent () const noexcept |
Return the parent dictionary. More... | |
const dictionary & | topDict () const |
Return the top of the tree. More... | |
label | startLineNumber () const |
Return line number of first token in dictionary. More... | |
label | endLineNumber () const |
Return line number of last token in dictionary. More... | |
SHA1Digest | digest () const |
Return the SHA1 digest of the dictionary contents. More... | |
tokenList | tokens () const |
Return the dictionary as a list of tokens. More... | |
const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry (const access) with the given keyword. More... | |
entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find an entry (non-const access) with the given keyword. More... | |
bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry (const access) with the given keyword. More... | |
const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search for a scoped entry (const access) with the given keyword. More... | |
const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More... | |
dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More... | |
bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find a sub-dictionary. More... | |
const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
Search for an entry (const access) with the given keyword. More... | |
ITstream & | lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return an entry data stream. FatalIOError if not found, or not a stream. More... | |
template<class T > | |
T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect. More... | |
template<class T > | |
T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T > | |
T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T > | |
bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More... | |
template<class T > | |
bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T , class Predicate > | |
T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect. More... | |
template<class T , class Predicate > | |
T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T , class Predicate > | |
T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T , class Predicate > | |
bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More... | |
template<class T , class Predicate > | |
bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More... | |
const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a sub-dictionary. More... | |
dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a sub-dictionary for manipulation. More... | |
dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a sub-dictionary for manipulation. More... | |
dictionary | subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const |
Find and return a sub-dictionary as a copy, otherwise return an empty dictionary. More... | |
const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a sub-dictionary, otherwise return this dictionary. More... | |
wordList | toc () const |
Return the table of contents. More... | |
wordList | sortedToc () const |
Return the sorted table of contents. More... | |
template<class Compare > | |
wordList | sortedToc (const Compare &comp) const |
Return table of contents sorted using the specified comparator. More... | |
List< keyType > | keys (bool patterns=false) const |
Return the list of available keys or patterns. More... | |
bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
Substitute the given keyword (which is prefixed by '$') More... | |
bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
Substitute the given scoped keyword (which is prefixed by '$') More... | |
entry * | add (entry *entryPtr, bool mergeEntry=false) |
Add a new entry. More... | |
entry * | add (const entry &e, bool mergeEntry=false) |
Add an entry. More... | |
entry * | add (const keyType &k, const word &v, bool overwrite=false) |
Add a word entry. More... | |
entry * | add (const keyType &k, const string &v, bool overwrite=false) |
Add a string entry. More... | |
entry * | add (const keyType &k, const label v, bool overwrite=false) |
Add a label entry. More... | |
entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
Add a scalar entry. More... | |
entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
Add a dictionary entry. More... | |
template<class T > | |
entry * | add (const keyType &k, const T &v, bool overwrite=false) |
Add a T entry. More... | |
entry * | set (entry *entryPtr) |
Assign a new entry, overwriting any existing entry. More... | |
entry * | set (const entry &e) |
Assign a new entry, overwriting any existing entry. More... | |
entry * | set (const keyType &k, const dictionary &v) |
Assign a dictionary entry, overwriting any existing entry. More... | |
template<class T > | |
entry * | set (const keyType &k, const T &v) |
Assign a T entry, overwriting any existing entry. More... | |
bool | remove (const word &keyword) |
Remove an entry specified by keyword. More... | |
bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
Change the keyword for an entry,. More... | |
bool | merge (const dictionary &dict) |
Merge entries from the given dictionary. More... | |
void | clear () |
Clear the dictionary. More... | |
void | transfer (dictionary &dict) |
Transfer the contents of the argument and annul the argument. More... | |
void | checkITstream (const ITstream &is, const word &keyword) const |
Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place. More... | |
bool | read (Istream &is) |
Read dictionary from Istream. Discards the header. More... | |
bool | read (Istream &is, bool keepHeader) |
Read dictionary from Istream, optionally keeping the header. More... | |
void | writeEntry (Ostream &os) const |
Write sub-dictionary with its dictName as its header. More... | |
void | writeEntry (const keyType &keyword, Ostream &os) const |
Write sub-dictionary with the keyword as its header. More... | |
void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
Write dictionary entries. More... | |
void | write (Ostream &os, const bool subDict=true) const |
Write dictionary, normally with sub-dictionary formatting. More... | |
const_searcher | csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Search dictionary for given keyword. More... | |
const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using scoping. More... | |
const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using dot or slash scoping. More... | |
searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
Search using dot or slash scoping. More... | |
const dictionary * | cfindScopedDict (const fileName &dictPath) const |
Locate a sub-dictionary using slash-scoping. More... | |
const dictionary * | findScopedDict (const fileName &dictPath) const |
Locate a sub-dictionary using slash-scoping. More... | |
dictionary * | findScopedDict (const fileName &dictPath) |
Locate a sub-dictionary using slash-scoping. More... | |
dictionary * | makeScopedDict (const fileName &dictPath) |
Locate existing or create sub-dictionary using slash-scoping. More... | |
const_searcher | csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword and any compatibility names. More... | |
const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const |
Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed. More... | |
bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword and any compatibility names. More... | |
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const |
Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed. More... | |
ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return an entry data stream, using any compatibility names if needed. More... | |
template<class T > | |
T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens. More... | |
template<class T > | |
T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T, or return the given default value using any compatibility names if needed. More... | |
template<class T > | |
bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens. More... | |
template<class T > | |
bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens. More... | |
void | operator= (const dictionary &rhs) |
Copy assignment. More... | |
void | operator+= (const dictionary &rhs) |
Include entries from the given dictionary. More... | |
void | operator|= (const dictionary &rhs) |
Conditionally include entries from the given dictionary. More... | |
void | operator<<= (const dictionary &rhs) |
Unconditionally include entries from the given dictionary. More... | |
bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< bool >(const word&, keyType::option) More... | |
label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< label >(const word&, keyType::option) More... | |
scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< scalar >(const word&, keyType::option) More... | |
string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< string >(const word&, keyType::option) More... | |
word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< word >(const word&, keyType::option) More... | |
fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Same as get< fileName >(const word&, keyType::option) More... | |
template<class T > | |
T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More... | |
template<class T > | |
T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More... | |
ITstream & | operator[] (const word &keyword) const |
Deprecated(2018-07) - use lookup() method. More... | |
bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
Deprecated(2018-10) More... | |
entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
Deprecated(2018-10) More... | |
const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
const dictionary * | subDictPtr (const word &keyword) const |
Deprecated(2018-10) More... | |
dictionary * | subDictPtr (const word &keyword) |
Deprecated(2018-10) Find and return a sub-dictionary pointer if present. More... | |
const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
Deprecated(2018-10) More... | |
template<class T > | |
T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
Deprecated(2018-10) More... | |
template<class T > | |
T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
Deprecated(2018-10) More... | |
template<class T > | |
bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
Deprecated(2018-10) More... | |
template<class T > | |
T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
Deprecated(2018-10) find and return a T. More... | |
template<class Compare > | |
Foam::wordList | sortedToc (const Compare &comp) const |
template<class T > | |
Foam::entry * | add (const keyType &k, const T &v, bool overwrite) |
template<class T > | |
Foam::entry * | set (const keyType &k, const T &v) |
Public Member Functions inherited from ILList< LListBase, T > | |
ILList ()=default | |
Default construct. More... | |
ILList (T *item) | |
Construct and add initial item pointer. More... | |
ILList (Istream &is) | |
Construct from Istream. More... | |
ILList (const ILList< LListBase, T > &lst) | |
Copy construct using the 'clone()' method for each element. More... | |
ILList (ILList< LListBase, T > &&lst) | |
Move construct. More... | |
template<class CloneArg > | |
ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone 'clone()'. More... | |
template<class INew > | |
ILList (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
~ILList () | |
Destructor. Calls clear() More... | |
void | clear () |
Clear the contents of the list. More... | |
void | pop_front (label n=1) |
Remove first element(s) from the list (deletes pointers) More... | |
bool | erase (T *item) |
Remove the specified element from the list and delete it. More... | |
void | transfer (ILList< LListBase, T > &lst) |
Transfer the contents of the argument into this List and annul the argument list. More... | |
void | operator= (const ILList< LListBase, T > &lst) |
Copy assignment using the 'clone()' method for each element. More... | |
void | operator= (ILList< LListBase, T > &&lst) |
Move assignment. More... | |
Public Member Functions inherited from UILList< LListBase, T > | |
UILList ()=default | |
Default construct. More... | |
UILList (T *item) | |
Construct and add initial item pointer. More... | |
UILList (const UILList< LListBase, T > &list) | |
Construct as copy. More... | |
T * | front () |
The first entry in the list. More... | |
const T * | front () const |
The first entry in the list (const access) More... | |
T * | back () |
The last entry in the list. More... | |
const T * | back () const |
The last entry in the list (const access) More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *item) |
Remove and return element. More... | |
T * | remove (iterator &iter) |
Remove and return item specified by iterator. More... | |
void | operator= (const UILList< LListBase, T > &lst) |
Copy assignment. More... | |
bool | operator== (const UILList< LListBase, T > &lst) const |
Equality. True both lists are element-wise equal. More... | |
bool | operator!= (const UILList< LListBase, T > &lst) const |
The opposite of the equality operation. Takes linear time. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write UILList with line-breaks when length exceeds shortLen. More... | |
iterator | begin () |
Iterator to first item in list with non-const access. More... | |
const_iterator | cbegin () const |
Iterator to first item in list with const access. More... | |
reverse_iterator | rbegin () |
Iterator to last item in list with non-const access. More... | |
const_reverse_iterator | crbegin () const |
Iterator to last item in list with const access. More... | |
const_iterator | begin () const |
Iterator to first item in list with const access. More... | |
const_reverse_iterator | rbegin () const |
Iterator to last item in list with const access. More... | |
const iterator & | end () |
End of list for forward iterators. More... | |
const const_iterator & | cend () const |
End of list for forward iterators. More... | |
const reverse_iterator & | rend () |
End of list for reverse iterators. More... | |
const const_reverse_iterator & | crend () const |
End of list for reverse iterators. More... | |
const const_iterator & | end () const |
End of list for forward iterators. More... | |
const const_reverse_iterator & | rend () const |
End of list for reverse iterators. More... | |
T * | first () |
The first entry in the list. More... | |
const T * | first () const |
The first entry in the list (const access) More... | |
T * | last () |
The last entry in the list. More... | |
const T * | last () const |
The last entry in the list (const access) More... | |
Protected Member Functions | |
incompressibleAdjointVars & | allocateVars () |
Allocate incompressibleAdjointVars and return reference to be used for convenience in the rest of the class. More... | |
void | addExtraSchemes () |
In case variable names are different than the base ones, add extra schemes and relaxation factors to the appropriate dicts. More... | |
void | continuityErrors () |
Compute continuity errors. More... | |
Protected Member Functions inherited from solver | |
solver (const solver &)=delete | |
No copy construct. More... | |
void | operator= (const solver &)=delete |
No copy assignment. 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 | |
autoPtr< SIMPLEControl > | solverControl_ |
Solver control. More... | |
incompressibleAdjointVars & | adjointVars_ |
Reference to incompressibleAdjointVars. More... | |
scalar | cumulativeContErr_ |
Cumulative continuity error. More... | |
autoPtr< incompressible::adjointSensitivity > | adjointSensitivity_ |
Sensitivity Derivatives engine. More... | |
Protected Attributes inherited from incompressibleAdjointSolver | |
incompressibleVars & | primalVars_ |
Primal variable set. More... | |
autoPtr< ATCModel > | ATCModel_ |
Adjoint Transpose Convection options. More... | |
Protected Attributes inherited from adjointSolver | |
const word | primalSolverName_ |
Name of primal solver. More... | |
autoPtr< objectiveManager > | objectiveManagerPtr_ |
Object to manage objective functions. More... | |
tmp< scalarField > | sensitivities_ |
Sensitivities field. More... | |
bool | computeSensitivities_ |
Are sensitivities computed. More... | |
bool | isConstraint_ |
Is the adjoint solver used to tackle a constraint. More... | |
Protected Attributes inherited from solver | |
fvMesh & | mesh_ |
Reference to the mesh database. More... | |
const word | managerType_ |
The optimisation type. More... | |
dictionary | dict_ |
Dictionary holding the solver info. More... | |
const word | solverName_ |
Solver name. More... | |
bool | active_ |
Solve equations? More... | |
const volScalarField * | optTypeSource_ |
Pointer to a source term coming from the optimisationType (e.g. porosity from topologyOptimisation) More... | |
autoPtr< variablesSet > | vars_ |
Base variableSet pointer. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
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... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Public Types inherited from dictionary | |
typedef Searcher< true > | const_searcher |
Searcher with const access. More... | |
typedef Searcher< false > | searcher |
Searcher with non-const access. More... | |
Public Types inherited from UILList< LListBase, T > | |
typedef T | value_type |
Type of values stored. More... | |
typedef T * | pointer |
Pointer for value_type. More... | |
typedef const T * | const_pointer |
Const pointer for value_type. More... | |
typedef T & | reference |
Reference for value_type. More... | |
typedef const T & | const_reference |
Const reference for value_type. More... | |
typedef label | size_type |
The type that can represent the container size. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
using | base_iterator = typename LListBase::iterator |
using | const_base_iterator = typename LListBase::const_iterator |
Static Public Member Functions inherited from incompressibleAdjointSolver | |
static autoPtr< incompressibleAdjointSolver > | New (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) |
Return a reference to the selected incompressible adjoint solver. More... | |
Static Public Member Functions inherited from adjointSolver | |
static autoPtr< adjointSolver > | New (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) |
Return a reference to the selected turbulence model. More... | |
Static Public Member Functions inherited from localIOdictionary | |
static dictionary | readContents (const IOobject &io) |
Read and return contents. The IOobject will not be registered. More... | |
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... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Static Public Member Functions inherited from dictionary | |
static int | reportOptional () noexcept |
Return the state of reporting optional (default) entries. More... | |
static int | reportOptional (const int level) noexcept |
Change the state of reporting optional (default) entries. More... | |
static autoPtr< dictionary > | New (Istream &is) |
Construct top-level dictionary on freestore from Istream. More... | |
Public Attributes inherited from dictionary | |
friend | const_searcher |
Declare friendship with the searcher classes. More... | |
friend | searcher |
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 Public Attributes inherited from dictionary | |
static int | writeOptionalEntries |
Report optional keywords and values if not present in dictionary. More... | |
static const dictionary | null |
An empty dictionary, which is also the parent for all dictionaries. More... | |
static refPtr< OSstream > | reportingOutput |
Output location when reporting default values. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Solution of the adjoint PDEs for incompressible, steady-state flows.
For the development of the adjoint PDEs Papoutsis-Kiachagias, E. M., & Giannakoglou, K. C. (2014). Continuous Adjoint Methods for Turbulent Flows, Applied to Shape and Topology Optimization: Industrial Applications. Archives of Computational Methods in Engineering, 23(2), 255-299. http://doi.org/10.1007/s11831-014-9141-9
Definition at line 58 of file adjointSimple.H.
adjointSimple | ( | fvMesh & | mesh, |
const word & | managerType, | ||
const dictionary & | dict, | ||
const word & | primalSolverName | ||
) |
Construct from mesh and dictionary.
Definition at line 98 of file adjointSimple.C.
References dict, dictionary::found(), objectRegistry::lookupObject(), mesh, adjointSensitivity::New(), ATCModel::New(), tmp< T >::New(), Foam::setRefCell(), and dictionary::subDict().
|
virtualdefault |
Destructor.
|
protected |
Allocate incompressibleAdjointVars and return reference to be used for convenience in the rest of the class.
Definition at line 46 of file adjointSimple.C.
References incompressibleAdjointSolver::getAdjointVars(), solver::mesh_, adjointSolver::objectiveManagerPtr_, incompressibleAdjointSolver::primalVars_, adjointSimple::solverControl_, and solver::vars_.
|
protected |
In case variable names are different than the base ones, add extra schemes and relaxation factors to the appropriate dicts.
Note: 160813: Changes in the baseline solution and fvSchemes classes have to be made in order to add schemes in the dict at run time. Not supported for now
Definition at line 62 of file adjointSimple.C.
References Foam::endl(), Foam::nl, Foam::tab, and WarningInFunction.
|
protected |
Compute continuity errors.
Definition at line 76 of file adjointSimple.C.
References contErr(), Foam::fvc::div(), Foam::endl(), globalContErr, Foam::Info, Foam::mag(), sumLocalContErr, and DimensionedField< Type, GeoMesh >::weightedAverage().
TypeName | ( | "adjointSimple" | ) |
Run-time type information.
|
virtual |
Read dict if updated.
Reimplemented from incompressibleAdjointSolver.
Definition at line 164 of file adjointSimple.C.
References dict, incompressibleAdjointSolver::readDict(), and dictionary::subDict().
|
virtual |
Execute one iteration of the solution algorithm.
Implements solver.
Definition at line 186 of file adjointSimple.C.
|
virtual |
Steps to be executed before each main SIMPLE iteration.
Definition at line 194 of file adjointSimple.C.
References Foam::endl(), and Foam::Info.
|
virtual |
The main SIMPLE iter.
Definition at line 200 of file adjointSimple.C.
References addProfiling, adjointRASModel::adjointMeanFlowSource(), Foam::adjustPhi(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvMatrix< Type >::boundaryManipulate(), optionList::constrain(), Foam::constrainHbyA(), optionList::correct(), adjointRASModel::correct(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::fvm::div(), Foam::fvc::div(), adjointRASModel::divDevReff(), Foam::endl(), Foam::fvc::flux(), fvMatrix< Type >::flux(), fvOptions, Foam::gMax(), Foam::fvc::grad(), Foam::Info, Foam::fvc::interpolate(), Foam::fvm::laplacian(), Foam::mag(), momentumPredictor, options::New(), paEqn(), phi, GeometricField< Type, PatchField, GeoMesh >::relax(), fvMatrix< Type >::setReference(), Foam::fvc::snGrad(), Foam::solve(), fvMatrix< Type >::solve(), and dimensioned< Type >::value().
|
virtual |
Steps to be executed before each main SIMPLE iteration.
Definition at line 323 of file adjointSimple.C.
References Foam::Info.
|
virtual |
Main control loop.
Implements solver.
Definition at line 335 of file adjointSimple.C.
References addProfiling.
|
virtual |
Looper (advances iters, time step)
Implements solver.
Definition at line 350 of file adjointSimple.C.
|
virtual |
Functions to be called before loop.
Reimplemented from solver.
Definition at line 356 of file adjointSimple.C.
|
virtual |
Compute sensitivities of the underlaying objectives.
Implements adjointSolver.
Definition at line 363 of file adjointSimple.C.
References UList< T >::size(), and Foam::Zero.
|
virtual |
Grab a reference to the computed sensitivities.
Implements adjointSolver.
Definition at line 382 of file adjointSimple.C.
|
virtual |
Clears the sensitivity field known by the adjoint solver and zeros sensitivities constituents.
Reimplemented from adjointSolver.
Definition at line 393 of file adjointSimple.C.
References adjointSolver::clearSensitivities().
|
virtual |
Return the base sensitivity object.
Implements adjointSolver.
Definition at line 403 of file adjointSimple.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
|
virtual |
Source terms for the momentum equations.
Definition at line 419 of file adjointSimple.C.
|
virtual |
Source terms for the continuity equation.
Definition at line 425 of file adjointSimple.C.
|
virtual |
Update primal based quantities related to the objective functions.
Also writes the objective function values to files. Written here and not in the postLoop function of the primal to make sure we don't pollute the objective files with objectives of non-converged linearSearch iterations
Reimplemented from incompressibleAdjointSolver.
Definition at line 431 of file adjointSimple.C.
References incompressibleAdjointSolver::updatePrimalBasedQuantities().
|
virtual |
Write average iteration.
Reimplemented from adjointSolver.
Definition at line 440 of file adjointSimple.C.
References os(), adjointSolver::writeData(), and Ostream::writeEntry().
|
protected |
Solver control.
Definition at line 85 of file adjointSimple.H.
Referenced by adjointSimple::allocateVars().
|
protected |
Reference to incompressibleAdjointVars.
Used for convenience and to avoid repetitive dynamic_casts Same as getAdjointVars()
Definition at line 93 of file adjointSimple.H.
|
protected |
Cumulative continuity error.
Definition at line 98 of file adjointSimple.H.
|
protected |
Sensitivity Derivatives engine.
Definition at line 103 of file adjointSimple.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.