Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors. More...
Public Member Functions | |
TypeName ("objective") | |
Runtime type information. More... | |
declareRunTimeNewSelectionTable (autoPtr, objective, objective,(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName),(mesh, dict, adjointSolverName, primalSolverName)) | |
objective (const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName) | |
Construct from components. More... | |
virtual | ~objective ()=default |
Destructor. More... | |
virtual bool | readDict (const dictionary &dict) |
virtual scalar | J ()=0 |
Return the instantaneous objective function value. More... | |
scalar | JCycle () const |
void | accumulateJMean (solverControl &solverControl) |
Accumulate contribution for the mean objective value. More... | |
void | accumulateJMean () |
Accumulate contribution for the mean objective value. More... | |
scalar | weight () const |
Return the objective function weight. More... | |
bool | normalize () const |
Is the objective normalized. More... | |
virtual void | doNormalization () |
Normalize all fields allocated by the objective. More... | |
bool | isWithinIntegrationTime () const |
Check whether this is an objective integration time. More... | |
void | incrementIntegrationTimes (const scalar timeSpan) |
Increment integration times. More... | |
const volScalarField & | dJdb () |
Contribution to field sensitivities. More... | |
const fvPatchVectorField & | boundarydJdb (const label) |
Contribution to surface sensitivities for a specific patch. More... | |
const fvPatchVectorField & | dSdbMultiplier (const label) |
Multiplier of delta(n dS)/delta b. More... | |
const fvPatchVectorField & | dndbMultiplier (const label) |
Multiplier of delta(n dS)/delta b. More... | |
const fvPatchVectorField & | dxdbMultiplier (const label) |
Multiplier of delta(x)/delta b. More... | |
const fvPatchVectorField & | dxdbDirectMultiplier (const label) |
Multiplier of delta(x)/delta b. More... | |
const vectorField & | boundaryEdgeMultiplier (const label patchI, const label edgeI) |
Multiplier located at patch boundary edges. More... | |
const boundaryVectorField & | boundarydJdb () |
Contribution to surface sensitivities for all patches. More... | |
const boundaryVectorField & | dSdbMultiplier () |
Multiplier of delta(n dS)/delta b for all patches. More... | |
const boundaryVectorField & | dndbMultiplier () |
Multiplier of delta(n dS)/delta b for all patches. More... | |
const boundaryVectorField & | dxdbMultiplier () |
Multiplier of delta(x)/delta b for all patches. More... | |
const boundaryVectorField & | dxdbDirectMultiplier () |
Multiplier of delta(x)/delta b for all patches. More... | |
const vectorField3 & | boundaryEdgeMultiplier () |
Multiplier located at patch boundary edges. More... | |
const volScalarField & | divDxDbMultiplier () |
Multiplier of grad( delta(x)/delta b) for volume-based sensitivities. More... | |
const volTensorField & | gradDxDbMultiplier () |
Multiplier of grad( delta(x)/delta b) for volume-based sensitivities. More... | |
virtual void | update ()=0 |
Update objective function derivatives. More... | |
virtual void | nullify () |
Nullify adjoint contributions. More... | |
virtual void | updateNormalizationFactor () |
virtual void | update_boundarydJdb () |
Update objective function derivative term. More... | |
virtual void | update_dSdbMultiplier () |
Update d (normal dS) / db multiplier. Surface-based sensitivity term. More... | |
virtual void | update_dndbMultiplier () |
Update d (normal) / db multiplier. Surface-based sensitivity term. More... | |
virtual void | update_dxdbMultiplier () |
Update d (x) / db multiplier. Surface-based sensitivity term. More... | |
virtual void | update_dxdbDirectMultiplier () |
virtual void | update_boundaryEdgeContribution () |
Update boundary edge contributions. More... | |
virtual void | update_divDxDbMultiplier () |
Update div( dx/db multiplier). Volume-based sensitivity term. More... | |
virtual void | update_gradDxDbMultiplier () |
Update grad( dx/db multiplier). Volume-based sensitivity term. More... | |
virtual bool | write (const bool valid=true) const |
Write objective function history. More... | |
virtual void | writeInstantaneousValue () const |
Write objective function history at each primal solver iteration. More... | |
virtual void | writeInstantaneousSeparator () const |
virtual void | writeMeanValue () const |
Write mean objective function history. More... | |
virtual bool | writeData (Ostream &os) const |
Write averaged objective for continuation. More... | |
virtual void | addHeaderInfo () const |
Write any information that needs to go the header of the file. More... | |
virtual void | addHeaderColumns () const |
Write headers for additional columns. More... | |
virtual void | addColumnValues () const |
Write information to additional columns. More... | |
const word & | objectiveName () const |
Return the objective name. More... | |
bool | hasdJdb () const |
bool | hasBoundarydJdb () const |
bool | hasdSdbMult () const |
bool | hasdndbMult () const |
bool | hasdxdbMult () const |
bool | hasdxdbDirectMult () const |
bool | hasBoundaryEdgeContribution () const |
bool | hasDivDxDbMult () const |
bool | hasGradDxDbMult () const |
bool | hasIntegrationStartTime () const |
bool | hasIntegrationEndTime () const |
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... | |
virtual fileName | filePath () const =0 |
const word & | name () const |
virtual bool | readData (Istream &) |
The readData function required by regIOobject read operation. More... | |
virtual bool | writeData (Ostream &) const |
The writeData function required by regIOobject write operation. More... | |
virtual bool | global () const =0 |
Is object global. 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 | registered () const noexcept |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool valid=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
bool | registerObject () const noexcept |
Should object created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference, return previous value. More... | |
bool | globalObject () const noexcept |
Is object same for all processors? More... | |
bool | globalObject (bool on) noexcept |
Change global-object status, return previous value. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
readOption | readOpt () const noexcept |
The read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Change the read option, return previous value. More... | |
writeOption | writeOpt () const noexcept |
The write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Change the write option, return previous value. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
bool | readHeader (Istream &is) |
bool | readHeader (dictionary &headerDict, Istream &is) |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
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 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... | |
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 * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=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 matchOpt=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 matchOpt=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 matchOpt=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 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. 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... | |
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 > &lst) | |
Construct as copy. 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... | |
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... | |
Static Public Member Functions | |
static autoPtr< objective > | New (const fvMesh &mesh, const dictionary &dict, const word &objectiveType, const word &adjointSolverName, 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 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 Member Functions | |
const dictionary & | dict () const |
Return objective dictionary. More... | |
void | setObjectiveFilePtr () const |
Set the output file ptr. More... | |
void | setInstantValueFilePtr () const |
Set the output file ptr for the instantaneous value. More... | |
void | setMeanValueFilePtr () const |
Set the output file ptr for the mean value. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Attributes | |
const fvMesh & | mesh_ |
dictionary | dict_ |
const word | adjointSolverName_ |
const word | primalSolverName_ |
const word | objectiveName_ |
bool | computeMeanFields_ |
bool | nullified_ |
bool | normalize_ |
scalar | J_ |
Objective function value and weight. More... | |
scalar | JMean_ |
Average objective value. More... | |
scalar | weight_ |
Objective weight. More... | |
autoPtr< scalar > | normFactor_ |
Normalization factor. More... | |
autoPtr< scalar > | target_ |
Target value, in case the objective is used as a constraint. More... | |
autoPtr< scalar > | integrationStartTimePtr_ |
Objective integration start and end times (for unsteady flows) More... | |
autoPtr< scalar > | integrationEndTimePtr_ |
autoPtr< volScalarField > | dJdbPtr_ |
Contribution to field sensitivity derivatives. More... | |
autoPtr< boundaryVectorField > | bdJdbPtr_ |
Term from material derivative. More... | |
autoPtr< boundaryVectorField > | bdSdbMultPtr_ |
Term multiplying delta(n dS)/delta b. More... | |
autoPtr< boundaryVectorField > | bdndbMultPtr_ |
Term multiplying delta(n)/delta b. More... | |
autoPtr< boundaryVectorField > | bdxdbMultPtr_ |
Term multiplying delta(x)/delta b at the boundary. More... | |
autoPtr< boundaryVectorField > | bdxdbDirectMultPtr_ |
autoPtr< vectorField3 > | bEdgeContribution_ |
autoPtr< volScalarField > | divDxDbMultPtr_ |
Multiplier of d(Volume)/db. More... | |
autoPtr< volTensorField > | gradDxDbMultPtr_ |
Emerging from volume objectives that include spatial derivatives. More... | |
fileName | objFunctionFolder_ |
Output file variables. More... | |
autoPtr< OFstream > | objFunctionFilePtr_ |
File to keep the objective values after the end of the primal solver. More... | |
autoPtr< OFstream > | instantValueFilePtr_ |
autoPtr< OFstream > | meanValueFilePtr_ |
unsigned int | width_ |
Default width of entries when writing in the objective files. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 } |
Enumeration defining the read options. More... | |
enum | writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
Enumeration defining the write options. More... | |
enum | objectState : char { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
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 |
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) |
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... | |
Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors.
Definition at line 59 of file objective.H.
objective | ( | const fvMesh & | mesh, |
const dictionary & | dict, | ||
const word & | adjointSolverName, | ||
const word & | primalSolverName | ||
) |
Construct from components.
Definition at line 102 of file objective.C.
References objective::dict(), dictionary::found(), dictionary::get(), objective::integrationEndTimePtr_, objective::integrationStartTimePtr_, objective::normalize_, objective::normFactor_, dictionary::readIfPresent(), autoPtr< T >::reset(), and Foam::Zero.
|
virtualdefault |
Destructor.
|
protected |
Return objective dictionary.
Definition at line 94 of file objective.C.
References objective::dict_.
Referenced by objectivePtLosses::initialize(), objectiveIncompressible::New(), objective::New(), objective::objective(), objectiveIncompressible::objectiveIncompressible(), objectivePartialVolume::objectivePartialVolume(), and objective::readDict().
|
protected |
Set the output file ptr.
Definition at line 59 of file objective.C.
References objective::adjointSolverName_, objective::objectiveName_, objective::objFunctionFilePtr_, and objective::objFunctionFolder_.
Referenced by objective::write().
|
protected |
Set the output file ptr for the instantaneous value.
Definition at line 68 of file objective.C.
References objective::adjointSolverName_, objective::instantValueFilePtr_, objective::objectiveName_, and objective::objFunctionFolder_.
Referenced by objective::writeInstantaneousValue().
|
protected |
Set the output file ptr for the mean value.
Definition at line 80 of file objective.C.
References objective::adjointSolverName_, objective::meanValueFilePtr_, objective::objectiveName_, and objective::objFunctionFolder_.
Referenced by objective::writeMeanValue().
TypeName | ( | "objective" | ) |
Runtime type information.
declareRunTimeNewSelectionTable | ( | autoPtr | , |
objective | , | ||
objective | , | ||
(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName) | , | ||
(mesh, dict, adjointSolverName, primalSolverName) | |||
) |
|
static |
Return a reference to the selected turbulence model.
Definition at line 204 of file objective.C.
References objective::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh.
|
virtual |
Definition at line 241 of file objective.C.
References objective::dict(), and objective::dict_.
|
pure virtual |
Return the instantaneous objective function value.
Implemented in objectiveForce, objectiveMoment, objectiveNutSqr, objectivePartialVolume, objectivePtLosses, and objectiveIncompressible.
Referenced by objective::JCycle().
scalar JCycle | ( | ) | const |
Return the mean objective function value, if it exists, otherwise the mean one
Definition at line 248 of file objective.C.
References objective::computeMeanFields_, objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::J(), objective::J_, objective::JMean_, objective::normalize_, objective::normFactor_, objective::target_, and autoPtr< T >::valid().
Referenced by objective::updateNormalizationFactor(), and objective::write().
void accumulateJMean | ( | solverControl & | solverControl | ) |
Accumulate contribution for the mean objective value.
For steady-state runs
Definition at line 285 of file objective.C.
References solverControl::averageIter(), solverControl::doAverageIter(), objective::J_, objective::JMean_, and Foam::Zero.
void accumulateJMean | ( | ) |
Accumulate contribution for the mean objective value.
For unsteady runs
Definition at line 302 of file objective.C.
References TimeState::deltaT(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::integrationStartTimePtr_, objective::isWithinIntegrationTime(), objective::J_, objective::JMean_, objective::mesh_, fvMesh::time(), IOobject::time(), and dimensioned< Type >::value().
scalar weight | ( | ) | const |
Return the objective function weight.
Definition at line 324 of file objective.C.
References objective::weight_.
bool normalize | ( | ) | const |
Is the objective normalized.
Definition at line 330 of file objective.C.
References objective::normalize_.
|
virtual |
Normalize all fields allocated by the objective.
Reimplemented in objectiveIncompressible.
Definition at line 336 of file objective.C.
References objective::bdJdbPtr_, objective::bdndbMultPtr_, objective::bdSdbMultPtr_, objective::bdxdbDirectMultPtr_, objective::bdxdbMultPtr_, objective::bEdgeContribution_, objective::divDxDbMultPtr_, objective::dJdbPtr_, objective::gradDxDbMultPtr_, objective::hasBoundarydJdb(), objective::hasBoundaryEdgeContribution(), objective::hasDivDxDbMult(), objective::hasdJdb(), objective::hasdndbMult(), objective::hasdSdbMult(), objective::hasdxdbDirectMult(), objective::hasdxdbMult(), objective::hasGradDxDbMult(), objective::normalize_, and objective::normFactor_.
Referenced by objectiveIncompressible::doNormalization().
bool isWithinIntegrationTime | ( | ) | const |
Check whether this is an objective integration time.
Definition at line 382 of file objective.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::integrationEndTimePtr_, objective::integrationStartTimePtr_, objective::mesh_, fvMesh::time(), IOobject::time(), and dimensioned< Type >::value().
Referenced by objective::accumulateJMean().
void incrementIntegrationTimes | ( | const scalar | timeSpan | ) |
Increment integration times.
Definition at line 403 of file objective.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::integrationEndTimePtr_, and objective::integrationStartTimePtr_.
const volScalarField & dJdb | ( | ) |
Contribution to field sensitivities.
Definition at line 419 of file objective.C.
References objective::dJdbPtr_, objective::mesh_, and objective::objectiveName_.
const fvPatchVectorField & boundarydJdb | ( | const label | patchI | ) |
Contribution to surface sensitivities for a specific patch.
Definition at line 439 of file objective.C.
References objective::bdJdbPtr_, and objective::mesh_.
const fvPatchVectorField & dSdbMultiplier | ( | const label | patchI | ) |
Multiplier of delta(n dS)/delta b.
Definition at line 449 of file objective.C.
References objective::bdSdbMultPtr_, and objective::mesh_.
const fvPatchVectorField & dndbMultiplier | ( | const label | patchI | ) |
Multiplier of delta(n dS)/delta b.
Definition at line 459 of file objective.C.
References objective::bdndbMultPtr_, and objective::mesh_.
const fvPatchVectorField & dxdbMultiplier | ( | const label | patchI | ) |
Multiplier of delta(x)/delta b.
Definition at line 469 of file objective.C.
References objective::bdxdbMultPtr_, and objective::mesh_.
const fvPatchVectorField & dxdbDirectMultiplier | ( | const label | patchI | ) |
Multiplier of delta(x)/delta b.
Definition at line 479 of file objective.C.
References objective::bdxdbDirectMultPtr_, and objective::mesh_.
const vectorField & boundaryEdgeMultiplier | ( | const label | patchI, |
const label | edgeI | ||
) |
Multiplier located at patch boundary edges.
Definition at line 489 of file objective.C.
References objective::bdxdbDirectMultPtr_, objective::bEdgeContribution_, Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
const boundaryVectorField & boundarydJdb | ( | ) |
Contribution to surface sensitivities for all patches.
Definition at line 505 of file objective.C.
References objective::bdJdbPtr_, and objective::mesh_.
const boundaryVectorField & dSdbMultiplier | ( | ) |
Multiplier of delta(n dS)/delta b for all patches.
Definition at line 515 of file objective.C.
References objective::bdSdbMultPtr_, and objective::mesh_.
const boundaryVectorField & dndbMultiplier | ( | ) |
Multiplier of delta(n dS)/delta b for all patches.
Definition at line 525 of file objective.C.
References objective::bdndbMultPtr_, and objective::mesh_.
const boundaryVectorField & dxdbMultiplier | ( | ) |
Multiplier of delta(x)/delta b for all patches.
Definition at line 535 of file objective.C.
References objective::bdxdbMultPtr_, and objective::mesh_.
const boundaryVectorField & dxdbDirectMultiplier | ( | ) |
Multiplier of delta(x)/delta b for all patches.
Definition at line 545 of file objective.C.
References objective::bdxdbDirectMultPtr_, and objective::mesh_.
const vectorField3 & boundaryEdgeMultiplier | ( | ) |
Multiplier located at patch boundary edges.
Definition at line 555 of file objective.C.
References objective::bdxdbDirectMultPtr_, objective::bEdgeContribution_, Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
const volScalarField & divDxDbMultiplier | ( | ) |
Multiplier of grad( delta(x)/delta b) for volume-based sensitivities.
Definition at line 568 of file objective.C.
References Foam::dimless, objective::divDxDbMultPtr_, objective::mesh_, and objective::objectiveName_.
const volTensorField & gradDxDbMultiplier | ( | ) |
Multiplier of grad( delta(x)/delta b) for volume-based sensitivities.
Definition at line 589 of file objective.C.
References Foam::dimLength, Foam::dimTime, objective::gradDxDbMultPtr_, objective::mesh_, objective::objectiveName_, Foam::pow2(), and Foam::pow3().
|
pure virtual |
Update objective function derivatives.
Implemented in objectiveIncompressible.
|
virtual |
Nullify adjoint contributions.
Reimplemented in objectiveIncompressible.
Definition at line 609 of file objective.C.
References objective::bdJdbPtr_, objective::bdndbMultPtr_, objective::bdSdbMultPtr_, objective::bdxdbDirectMultPtr_, objective::bdxdbMultPtr_, objective::bEdgeContribution_, objective::divDxDbMultPtr_, objective::dJdbPtr_, field(), objective::gradDxDbMultPtr_, objective::hasBoundarydJdb(), objective::hasBoundaryEdgeContribution(), objective::hasDivDxDbMult(), objective::hasdJdb(), objective::hasdndbMult(), objective::hasdSdbMult(), objective::hasdxdbDirectMult(), objective::hasdxdbMult(), objective::hasGradDxDbMult(), objective::nullified_, and Foam::Zero.
Referenced by objectiveIncompressible::nullify().
|
virtual |
Update normalization factors, for objectives in which the factor is not known a priori
Definition at line 276 of file objective.C.
References objective::JCycle(), objective::normalize_, objective::normFactor_, and autoPtr< T >::reset().
|
inlinevirtual |
Update objective function derivative term.
Reimplemented in objectiveIncompressible.
Definition at line 330 of file objective.H.
|
inlinevirtual |
Update d (normal dS) / db multiplier. Surface-based sensitivity term.
Reimplemented in objectiveForce, objectiveIncompressible, objectiveMoment, and objectivePartialVolume.
Definition at line 334 of file objective.H.
|
inlinevirtual |
Update d (normal) / db multiplier. Surface-based sensitivity term.
Reimplemented in objectiveIncompressible.
Definition at line 338 of file objective.H.
|
inlinevirtual |
Update d (x) / db multiplier. Surface-based sensitivity term.
Reimplemented in objectiveForce, objectiveIncompressible, and objectiveMoment.
Definition at line 342 of file objective.H.
|
inlinevirtual |
Update d (x) / db multiplier. Surface and volume-based sensitivity term
Reimplemented in objectiveIncompressible, objectiveMoment, and objectivePartialVolume.
Definition at line 347 of file objective.H.
|
inlinevirtual |
Update boundary edge contributions.
Definition at line 351 of file objective.H.
Referenced by objectiveIncompressible::update().
|
inlinevirtual |
Update div( dx/db multiplier). Volume-based sensitivity term.
Reimplemented in objectiveIncompressible, and objectiveNutSqr.
Definition at line 355 of file objective.H.
|
inlinevirtual |
Update grad( dx/db multiplier). Volume-based sensitivity term.
Reimplemented in objectiveIncompressible.
Definition at line 359 of file objective.H.
Write objective function history.
Reimplemented from regIOobject.
Reimplemented in objectiveIncompressible.
Definition at line 660 of file objective.C.
References objective::addColumnValues(), objective::addHeaderColumns(), objective::addHeaderInfo(), Foam::endl(), OSstream::flags(), objective::J_, objective::JCycle(), splitCell::master(), objective::mesh_, objective::normalize_, objective::normFactor_, objective::objFunctionFilePtr_, objective::setObjectiveFilePtr(), Foam::setw(), objective::target_, fvMesh::time(), autoPtr< T >::valid(), dimensioned< Type >::value(), and objective::width_.
|
virtual |
Write objective function history at each primal solver iteration.
Definition at line 704 of file objective.C.
References Foam::endl(), objective::instantValueFilePtr_, objective::J_, splitCell::master(), objective::mesh_, objective::setInstantValueFilePtr(), Foam::tab, fvMesh::time(), and dimensioned< Type >::value().
|
virtual |
Append a blank line after the end of optimisation cycle to the file holding the instantaneous objective values to facilitate plotting
Definition at line 721 of file objective.C.
References Foam::endl(), objective::instantValueFilePtr_, and splitCell::master().
|
virtual |
Write mean objective function history.
Definition at line 733 of file objective.C.
References objective::computeMeanFields_, Foam::endl(), objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::JMean_, splitCell::master(), objective::meanValueFilePtr_, objective::mesh_, objective::setMeanValueFilePtr(), Foam::tab, fvMesh::time(), and dimensioned< Type >::value().
Write averaged objective for continuation.
Reimplemented from baseIOdictionary.
Definition at line 760 of file objective.C.
References IOstream::good(), objective::JMean_, objective::normFactor_, os(), and Ostream::writeEntry().
|
virtual |
Write any information that needs to go the header of the file.
(e.g. targets, directions, etc)
Reimplemented in objectivePartialVolume.
Definition at line 771 of file objective.C.
Referenced by objective::write().
|
virtual |
Write headers for additional columns.
Reimplemented in objectivePtLosses.
Definition at line 777 of file objective.C.
Referenced by objective::write().
|
virtual |
Write information to additional columns.
Reimplemented in objectivePtLosses.
Definition at line 783 of file objective.C.
Referenced by objective::write().
|
inline |
Return the objective name.
Definition at line 33 of file objectiveI.H.
References objective::objectiveName_.
|
inline |
Definition at line 39 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 45 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 51 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 57 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 63 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 69 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 75 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 81 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 87 of file objectiveI.H.
References bool.
Referenced by objective::doNormalization(), and objective::nullify().
|
inline |
Definition at line 93 of file objectiveI.H.
References bool.
Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), objective::JCycle(), and objective::writeMeanValue().
|
inline |
Definition at line 99 of file objectiveI.H.
References bool.
Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), objective::JCycle(), and objective::writeMeanValue().
|
protected |
Definition at line 67 of file objective.H.
Referenced by objective::accumulateJMean(), objectivePtLosses::addHeaderColumns(), objective::boundarydJdb(), objectiveIncompressible::boundarydJdGradU(), objectiveIncompressible::boundarydJdnut(), objectiveIncompressible::boundarydJdp(), objectiveIncompressible::boundarydJdT(), objectiveIncompressible::boundarydJdTMvar1(), objectiveIncompressible::boundarydJdTMvar2(), objectiveIncompressible::boundarydJdv(), objectiveIncompressible::boundarydJdvn(), objectiveIncompressible::boundarydJdvt(), objective::divDxDbMultiplier(), objective::dJdb(), objectiveIncompressible::dJdp(), objectiveIncompressible::dJdT(), objectiveIncompressible::dJdTMvar1(), objectiveIncompressible::dJdTMvar2(), objectiveIncompressible::dJdv(), objective::dndbMultiplier(), objective::dSdbMultiplier(), objective::dxdbDirectMultiplier(), objective::dxdbMultiplier(), objective::gradDxDbMultiplier(), objectivePtLosses::initialize(), objective::isWithinIntegrationTime(), objectiveForce::J(), objectiveMoment::J(), objectiveNutSqr::J(), objectivePartialVolume::J(), objectivePtLosses::J(), objectiveForce::objectiveForce(), objectiveMoment::objectiveMoment(), objectiveNutSqr::objectiveNutSqr(), objectivePartialVolume::objectivePartialVolume(), objectivePtLosses::objectivePtLosses(), objectiveForce::update_boundarydJdGradU(), objectiveForce::update_boundarydJdnut(), objectiveMoment::update_boundarydJdnut(), objectiveMoment::update_boundarydJdp(), objectivePtLosses::update_boundarydJdp(), objectivePtLosses::update_boundarydJdv(), objectivePtLosses::update_boundarydJdvn(), objectivePtLosses::update_boundarydJdvt(), objectiveNutSqr::update_divDxDbMultiplier(), objectiveNutSqr::update_dJdTMvar1(), objectiveMoment::update_dSdbMultiplier(), objectivePartialVolume::update_dSdbMultiplier(), objectiveMoment::update_dxdbDirectMultiplier(), objectivePartialVolume::update_dxdbDirectMultiplier(), objectiveForce::update_dxdbMultiplier(), objectiveMoment::update_dxdbMultiplier(), objective::write(), objective::writeInstantaneousValue(), and objective::writeMeanValue().
|
protected |
Definition at line 68 of file objective.H.
Referenced by objective::dict(), and objective::readDict().
|
protected |
Definition at line 69 of file objective.H.
Referenced by objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().
|
protected |
Definition at line 70 of file objective.H.
|
protected |
Definition at line 71 of file objective.H.
Referenced by objective::divDxDbMultiplier(), objective::dJdb(), objective::gradDxDbMultiplier(), objective::objectiveName(), objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().
|
protected |
Definition at line 72 of file objective.H.
Referenced by objective::JCycle(), objectiveIncompressible::objectiveIncompressible(), objectiveMoment::update_meanValues(), and objective::writeMeanValue().
|
protected |
Definition at line 73 of file objective.H.
Referenced by objectiveIncompressible::nullify(), and objective::nullify().
|
protected |
Definition at line 74 of file objective.H.
Referenced by objectiveIncompressible::doNormalization(), objective::doNormalization(), objective::JCycle(), objective::normalize(), objective::objective(), objective::updateNormalizationFactor(), and objective::write().
|
protected |
Objective function value and weight.
Definition at line 77 of file objective.H.
Referenced by objective::accumulateJMean(), objectiveForce::J(), objectiveMoment::J(), objectiveNutSqr::J(), objectivePartialVolume::J(), objectivePtLosses::J(), objective::JCycle(), objective::write(), and objective::writeInstantaneousValue().
|
protected |
Average objective value.
Definition at line 80 of file objective.H.
Referenced by objective::accumulateJMean(), objective::JCycle(), objective::writeData(), and objective::writeMeanValue().
|
protected |
Objective weight.
Definition at line 83 of file objective.H.
Referenced by objectiveIncompressible::objectiveIncompressible(), and objective::weight().
|
protected |
Normalization factor.
Definition at line 86 of file objective.H.
Referenced by objectiveIncompressible::doNormalization(), objective::doNormalization(), objective::JCycle(), objective::objective(), objective::updateNormalizationFactor(), objective::write(), and objective::writeData().
|
protected |
Target value, in case the objective is used as a constraint.
Should be used in caution and with updateMethods than get affected by the target value, without requiring a sqr (e.g. SQP, MMA)
Definition at line 91 of file objective.H.
Referenced by objective::JCycle(), and objective::write().
|
protected |
Objective integration start and end times (for unsteady flows)
Definition at line 94 of file objective.H.
Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), and objective::objective().
|
protected |
Definition at line 95 of file objective.H.
Referenced by objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), and objective::objective().
|
protected |
Contribution to field sensitivity derivatives.
Topology optimisation or other variants with as many design variables as the mesh cells
Definition at line 100 of file objective.H.
Referenced by objective::dJdb(), objective::doNormalization(), and objective::nullify().
|
protected |
Term from material derivative.
Definition at line 106 of file objective.H.
Referenced by objective::boundarydJdb(), objective::doNormalization(), and objective::nullify().
|
protected |
Term multiplying delta(n dS)/delta b.
Definition at line 109 of file objective.H.
Referenced by objective::doNormalization(), objective::dSdbMultiplier(), objective::nullify(), objectiveForce::objectiveForce(), objectiveMoment::objectiveMoment(), objectivePartialVolume::objectivePartialVolume(), objectiveForce::update_dSdbMultiplier(), objectiveMoment::update_dSdbMultiplier(), and objectivePartialVolume::update_dSdbMultiplier().
|
protected |
Term multiplying delta(n)/delta b.
Definition at line 112 of file objective.H.
Referenced by objective::dndbMultiplier(), objective::doNormalization(), and objective::nullify().
|
protected |
Term multiplying delta(x)/delta b at the boundary.
Definition at line 115 of file objective.H.
Referenced by objective::doNormalization(), objective::dxdbMultiplier(), objective::nullify(), objectiveForce::objectiveForce(), objectiveMoment::objectiveMoment(), objectiveForce::update_dxdbMultiplier(), and objectiveMoment::update_dxdbMultiplier().
|
protected |
Term multiplying delta(x)/delta b at the boundary for objectives that directly depend on x, e.g. moment Needed in both FI and SI computations
Definition at line 120 of file objective.H.
Referenced by objective::boundaryEdgeMultiplier(), objective::doNormalization(), objective::dxdbDirectMultiplier(), objective::nullify(), objectiveMoment::objectiveMoment(), objectivePartialVolume::objectivePartialVolume(), objectiveMoment::update_dxdbDirectMultiplier(), and objectivePartialVolume::update_dxdbDirectMultiplier().
|
protected |
Contribution located in specific parts of a patch. Mainly intended for patch boundary edges contributions, e.g. NURBS surfaces G1 continuity
Definition at line 125 of file objective.H.
Referenced by objective::boundaryEdgeMultiplier(), objective::doNormalization(), and objective::nullify().
|
protected |
Multiplier of d(Volume)/db.
Definition at line 132 of file objective.H.
Referenced by objective::divDxDbMultiplier(), objective::doNormalization(), objective::nullify(), objectiveNutSqr::objectiveNutSqr(), and objectiveNutSqr::update_divDxDbMultiplier().
|
protected |
Emerging from volume objectives that include spatial derivatives.
Definition at line 135 of file objective.H.
Referenced by objective::doNormalization(), objective::gradDxDbMultiplier(), and objective::nullify().
|
protected |
Output file variables.
Definition at line 138 of file objective.H.
Referenced by objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().
File to keep the objective values after the end of the primal solver.
Definition at line 141 of file objective.H.
Referenced by objectivePtLosses::addColumnValues(), objectivePtLosses::addHeaderColumns(), objectivePartialVolume::addHeaderInfo(), objective::setObjectiveFilePtr(), and objective::write().
File to keep the objective values at each iteration of the primal solver
Definition at line 145 of file objective.H.
Referenced by objective::setInstantValueFilePtr(), objective::writeInstantaneousSeparator(), and objective::writeInstantaneousValue().
File to keep the average objective values after the end of the primal solver
Definition at line 149 of file objective.H.
Referenced by objective::setMeanValueFilePtr(), and objective::writeMeanValue().
|
protected |
Default width of entries when writing in the objective files.
Definition at line 152 of file objective.H.
Referenced by objectivePtLosses::addColumnValues(), objectivePtLosses::addHeaderColumns(), objectivePartialVolume::addHeaderInfo(), and objective::write().