Base class for incompressibleAdjoint solvers. More...
Public Member Functions | |
| 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 | readDict (const dictionary &dict) |
| Read dict if updated. 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 void | updatePrimalBasedQuantities () |
| virtual bool | write (const bool valid=true) const |
| virtual bool | writeNow () const |
 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 |
| primalSolver & | getPrimalSolver () |
| 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 | computeObjectiveSensitivities ()=0 |
| Compute sensitivities of the underlaying objectives. More... | |
| virtual bool | isConstraint () |
| Is the solving referring to a constraint. More... | |
| virtual const scalarField & | getObjectiveSensitivities ()=0 |
| Grab a reference to the computed sensitivities. More... | |
| virtual void | clearSensitivities () |
| Clears the sensitivity field known by the adjoint solver. More... | |
| virtual sensitivity & | getSensitivityBase ()=0 |
| Return the base sensitivity object. 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 | solveIter ()=0 |
| Execute one iteration of the solution algorithm. More... | |
| virtual void | solve ()=0 |
| Main control loop. More... | |
| virtual bool | loop ()=0 |
| Looper (advances iters, time step) More... | |
| virtual void | restoreInitValues () |
| Restore initial field values if necessary. More... | |
| virtual void | preLoop () |
| Functions to be called before loop. More... | |
| virtual void | postLoop () |
| Functions to be called after loop. 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... | |
| virtual bool | writeData (Ostream &) const |
| Required by regIOobject. More... | |
| Public Member Functions inherited from localIOdictionary | |
| localIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
| 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) | |
| 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) | |
| baseIOdictionary (const IOobject &io, const dictionary &dict) | |
| baseIOdictionary (const IOobject &io, Istream &is) | |
| Construct given an IOobject and Istream (ununsed) More... | |
| const word & | name () const |
| 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) | |
| 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... | |
| 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. 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 | 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 |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| 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... | |
| 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 r=NO_READ, writeOption w=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 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 ®istry, 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 ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io 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 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 |
| Return non-constant access to the optional note. 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 | 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 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 |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| 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 |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| 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 | isHeaderClassName () 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 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) | |
| dictionary (Istream &is) | |
| dictionary (Istream &is, bool keepHeader) | |
| 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... | |
| bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for an entry (const access) with the given keyword. More... | |
| entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find for an entry (non-const access) with the given keyword. More... | |
| const entry * | findEntry (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... | |
| dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary pointer if present. More... | |
| const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary pointer if present. 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 |
| template<class T > | |
| T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T > | |
| bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
| template<class T > | |
| bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T , class Predicate > | |
| T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T , class Predicate > | |
| bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
| template<class T , class Predicate > | |
| bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Check if entry is found and is a sub-dictionary. 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 |
| 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 |
| 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=keyType::REGEX) const |
| Search dictionary for given keyword. More... | |
| const_searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword. More... | |
| searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) |
| Search dictionary for given keyword. More... | |
| const_searcher | csearchScoped (const word &keyword, enum keyType::option) const |
| Search using scoping. More... | |
| const_searcher | searchScoped (const word &keyword, enum keyType::option) const |
| Search using dot or slash scoping. More... | |
| searcher | searchScoped (const word &keyword, enum keyType::option) |
| 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=keyType::REGEX) const |
| Search dictionary for given keyword and any compatibility names. More... | |
| bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=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) const |
| const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const |
| ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const |
| template<class T > | |
| bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const |
| template<class T > | |
| bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const |
| 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... | |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| template<class T > | |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| template<class T > | |
| T | lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| ITstream & | operator[] (const word &keyword) const |
| Deprecated(2018-07) find and return an entry data stream. 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) |
| 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... | |
| 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 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 insert the initial T 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. More... | |
| bool | eraseHead () |
| Remove the head element specified from the list and delete it. More... | |
| bool | erase (T *item) |
| Remove the specified element from the list and delete it. More... | |
| void | clear () |
| Clear the contents of the list. More... | |
| void | transfer (ILList< LListBase, T > &lst) |
| 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... | |
Static Public Member Functions | |
| 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 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 an 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 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... | |
Protected Attributes | |
| 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... | |
| autoPtr< 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_ |
| 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 | 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... | |
| 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 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... | |
| 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... | |
| 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 incompressibleAdjoint solvers.
Definition at line 53 of file incompressibleAdjointSolver.H.
| incompressibleAdjointSolver | ( | fvMesh & | mesh, |
| const word & | managerType, | ||
| const dictionary & | dict, | ||
| const word & | primalSolverName | ||
| ) |
Construct from mesh and dictionary.
Definition at line 52 of file incompressibleAdjointSolver.C.
|
virtualdefault |
Destructor.
| TypeName | ( | "incompressible" | ) |
Run-time type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| incompressibleAdjointSolver | , | ||
| dictionary | , | ||
| (fvMesh &mesh, const word &managerType, const dictionary &dict, const word &primalSolverName) | , | ||
| (mesh, managerType, dict, primalSolverName) | |||
| ) |
|
static |
Return a reference to the selected incompressible adjoint solver.
Definition at line 73 of file incompressibleAdjointSolver.C.
References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh.
|
virtual |
Read dict if updated.
Reimplemented from adjointSolver.
Reimplemented in adjointSimple.
Definition at line 104 of file incompressibleAdjointSolver.C.
References solver::dict(), and adjointSolver::readDict().
Referenced by adjointSimple::readDict().
|
virtual |
Should solver name be appended to fields.
Implements solver.
Definition at line 114 of file incompressibleAdjointSolver.C.
| const Foam::incompressibleVars & getPrimalVars | ( | ) | const |
Access to the incompressible primal variables set.
Definition at line 121 of file incompressibleAdjointSolver.C.
|
virtual |
Access to the incompressible adjoint variables set.
Definition at line 129 of file incompressibleAdjointSolver.C.
Referenced by boundaryAdjointContributionIncompressible::adjointVars(), and adjointSimple::allocateVars().
|
virtual |
Access to the incompressible adjoint variables set.
Definition at line 138 of file incompressibleAdjointSolver.C.
| const Foam::autoPtr< Foam::ATCModel > & getATCModel | ( | ) | const |
Access to the ATC model.
Definition at line 148 of file incompressibleAdjointSolver.C.
| Foam::autoPtr< Foam::ATCModel > & getATCModel | ( | ) |
Access to the ATC model.
Definition at line 154 of file incompressibleAdjointSolver.C.
|
virtual |
Update primal based quantities, e.g. the primal fields in adjoint turbulence models
Reimplemented from adjointSolver.
Reimplemented in adjointSimple.
Definition at line 160 of file incompressibleAdjointSolver.C.
Referenced by adjointSimple::updatePrimalBasedQuantities().
In case of multi-point runs with turbulent flows, output dummy turbulence fields with the base names, to allow continuation
Reimplemented from solver.
Definition at line 175 of file incompressibleAdjointSolver.H.
References solver::mesh_, incompressibleAdjointSolver::primalVars_, fvMesh::time(), incompressibleVars::write(), and TimeState::writeTime().
|
inlinevirtual |
In case of multi-point runs with turbulent flows, output dummy turbulence fields with the base names, to allow continuation
Reimplemented from solver.
Definition at line 188 of file incompressibleAdjointSolver.H.
References incompressibleAdjointSolver::primalVars_, and incompressibleVars::write().
|
protected |
Primal variable set.
Definition at line 76 of file incompressibleAdjointSolver.H.
Referenced by adjointSimple::allocateVars(), incompressibleAdjointSolver::write(), and incompressibleAdjointSolver::writeNow().
Adjoint Transpose Convection options.
Definition at line 79 of file incompressibleAdjointSolver.H.
1.8.17 