Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
objectiveIncompressible Class Referenceabstract

Abstract base class for objective functions in incompressible flows. More...

Inheritance diagram for objectiveIncompressible:
Inheritance graph
[legend]
Collaboration diagram for objectiveIncompressible:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("incompressible")
 
 declareRunTimeSelectionTable (autoPtr, objectiveIncompressible, dictionary,(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName),(mesh, dict, adjointSolverName, primalSolverName))
 
 objectiveIncompressible (const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
 
virtual ~objectiveIncompressible ()=default
 
virtual scalar J ()=0
 
virtual void doNormalization ()
 
const volVectorFielddJdv ()
 
const volScalarFielddJdp ()
 
const volScalarFielddJdT ()
 
const volScalarFielddJdTMvar1 ()
 
const volScalarFielddJdTMvar2 ()
 
const fvPatchVectorFieldboundarydJdv (const label)
 
const fvPatchScalarFieldboundarydJdvn (const label)
 
const fvPatchVectorFieldboundarydJdvt (const label)
 
const fvPatchVectorFieldboundarydJdp (const label)
 
const fvPatchScalarFieldboundarydJdT (const label)
 
const fvPatchScalarFieldboundarydJdTMvar1 (const label)
 
const fvPatchScalarFieldboundarydJdTMvar2 (const label)
 
const boundaryVectorFieldboundarydJdv ()
 
const boundaryScalarFieldboundarydJdvn ()
 
const boundaryVectorFieldboundarydJdvt ()
 
const boundaryVectorFieldboundarydJdp ()
 
const boundaryScalarFieldboundarydJdT ()
 
const boundaryScalarFieldboundarydJdTMvar1 ()
 
const boundaryScalarFieldboundarydJdTMvar2 ()
 
virtual void update ()
 
virtual void nullify ()
 
virtual void update_dJdv ()
 
virtual void update_dJdp ()
 
virtual void update_dJdT ()
 
virtual void update_dJdTMvar1 ()
 
virtual void update_dJdTMvar2 ()
 
virtual void update_dJdb ()
 
virtual void update_divDxDbMultiplier ()
 
virtual void update_gradDxDbMultiplier ()
 
virtual void update_boundarydJdv ()
 
virtual void update_boundarydJdvn ()
 
virtual void update_boundarydJdvt ()
 
virtual void update_boundarydJdp ()
 
virtual void update_boundarydJdT ()
 
virtual void update_boundarydJdTMvar1 ()
 
virtual void update_boundarydJdTMvar2 ()
 
virtual void update_boundarydJdb ()
 
virtual void update_dSdbMultiplier ()
 
virtual void update_dndbMultiplier ()
 
virtual void update_dxdbMultiplier ()
 
virtual void update_dxdbDirectMultiplier ()
 
virtual void update_meanValues ()
 
virtual bool write (const bool valid=true) const
 
bool hasdJdv () const
 
bool hasdJdp () const
 
bool hasdJdT () const
 
bool hasdJdTMVar1 () const
 
bool hasdJdTMVar2 () const
 
bool hasBoundarydJdv () const
 
bool hasBoundarydJdvn () const
 
bool hasBoundarydJdvt () const
 
bool hasBoundarydJdp () const
 
bool hasBoundarydJdT () const
 
bool hasBoundarydJdTMVar1 () const
 
bool hasBoundarydJdTMVar2 () const
 
- Public Member Functions inherited from objective
 TypeName ("objective")
 
 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)
 
virtual ~objective ()=default
 
virtual bool readDict (const dictionary &dict)
 
scalar JCycle () const
 
void accumulateJMean (solverControl &solverControl)
 
void accumulateJMean ()
 
scalar weight () const
 
bool normalize () const
 
bool isWithinIntegrationTime () const
 
void incrementIntegrationTimes (const scalar timeSpan)
 
const volScalarFielddJdb ()
 
const fvPatchVectorFieldboundarydJdb (const label)
 
const fvPatchVectorFielddSdbMultiplier (const label)
 
const fvPatchVectorFielddndbMultiplier (const label)
 
const fvPatchVectorFielddxdbMultiplier (const label)
 
const fvPatchVectorFielddxdbDirectMultiplier (const label)
 
const vectorFieldboundaryEdgeMultiplier (const label patchI, const label edgeI)
 
const fvPatchTensorFieldboundarydJdStress (const label)
 
const boundaryVectorFieldboundarydJdb ()
 
const boundaryVectorFielddSdbMultiplier ()
 
const boundaryVectorFielddndbMultiplier ()
 
const boundaryVectorFielddxdbMultiplier ()
 
const boundaryVectorFielddxdbDirectMultiplier ()
 
const vectorField3boundaryEdgeMultiplier ()
 
const boundaryTensorFieldboundarydJdStress ()
 
const volScalarFielddivDxDbMultiplier ()
 
const volTensorFieldgradDxDbMultiplier ()
 
virtual void updateNormalizationFactor ()
 
virtual void update_boundaryEdgeContribution ()
 
virtual void update_dJdStressMultiplier ()
 
virtual void writeInstantaneousValue () const
 
virtual void writeInstantaneousSeparator () const
 
virtual void writeMeanValue () const
 
virtual bool writeData (Ostream &os) const
 
virtual void addHeaderInfo () const
 
virtual void addHeaderColumns () const
 
virtual void addColumnValues () const
 
const wordobjectiveName () const
 
bool hasdJdb () const
 
bool hasBoundarydJdb () const
 
bool hasdSdbMult () const
 
bool hasdndbMult () const
 
bool hasdxdbMult () const
 
bool hasdxdbDirectMult () const
 
bool hasBoundaryEdgeContribution () const
 
bool hasBoundarydJdStress () 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)
 
 localIOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 localIOdictionary (const IOobject &io, Istream &is)
 
virtual ~localIOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const wordname () const
 
virtual bool readData (Istream &)
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionaryfindMetaData () const noexcept
 
dictionarygetMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobjectclone () const
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 
const objectRegistrydb () const noexcept
 
const Timetime () const
 
const wordname () const noexcept
 
const wordheaderClassName () const noexcept
 
wordheaderClassName () noexcept
 
const stringnote () const noexcept
 
stringnote () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
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)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
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< IOobjectinfo () const
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 
writeOptionwriteOpt () noexcept
 
boolregisterObject () noexcept
 
boolglobalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 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)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionaryclone () const
 
virtual ~dictionary ()
 
const fileNamename () const noexcept
 
fileNamename () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionaryparent () const noexcept
 
const dictionarytopDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
ITstreamlookup (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
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyTypekeys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 
entryadd (const entry &e, bool mergeEntry=false)
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 
entryset (entry *entryPtr)
 
entryset (const entry &e)
 
entryset (const keyType &k, const dictionary &v)
 
template<class T >
entryset (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 
dictionaryfindScopedDict (const fileName &dictPath)
 
dictionarymakeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (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)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
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
 
ITstreamoperator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionarysubDictPtr (const word &keyword) const
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
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::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Static Public Member Functions

static autoPtr< objectiveIncompressibleNew (const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
 
- Static Public Member Functions inherited from objective
static autoPtr< objectiveNew (const fvMesh &mesh, const dictionary &dict, const word &objectiveType, const word &adjointSolverName, const word &primalSolverName)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 
static OstreamwriteDivider (Ostream &os)
 
static OstreamwriteEndDivider (Ostream &os)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionaryNew (Istream &is)
 

Protected Attributes

const incompressibleVarsvars_
 
autoPtr< volVectorFielddJdvPtr_
 
autoPtr< volScalarFielddJdpPtr_
 
autoPtr< volScalarFielddJdTPtr_
 
autoPtr< volScalarFielddJdTMvar1Ptr_
 
autoPtr< volScalarFielddJdTMvar2Ptr_
 
autoPtr< boundaryVectorFieldbdJdvPtr_
 
autoPtr< boundaryScalarFieldbdJdvnPtr_
 
autoPtr< boundaryVectorFieldbdJdvtPtr_
 
autoPtr< boundaryVectorFieldbdJdpPtr_
 
autoPtr< boundaryScalarFieldbdJdTPtr_
 
autoPtr< boundaryScalarFieldbdJdTMvar1Ptr_
 
autoPtr< boundaryScalarFieldbdJdTMvar2Ptr_
 
- Protected Attributes inherited from objective
const fvMeshmesh_
 
dictionary dict_
 
const word adjointSolverName_
 
const word primalSolverName_
 
const word objectiveName_
 
bool computeMeanFields_
 
bool nullified_
 
bool normalize_
 
scalar J_
 
scalar JMean_
 
scalar weight_
 
autoPtr< scalar > normFactor_
 
autoPtr< scalar > target_
 
autoPtr< scalar > integrationStartTimePtr_
 
autoPtr< scalar > integrationEndTimePtr_
 
autoPtr< volScalarFielddJdbPtr_
 
autoPtr< boundaryVectorFieldbdJdbPtr_
 
autoPtr< boundaryVectorFieldbdSdbMultPtr_
 
autoPtr< boundaryVectorFieldbdndbMultPtr_
 
autoPtr< boundaryVectorFieldbdxdbMultPtr_
 
autoPtr< boundaryVectorFieldbdxdbDirectMultPtr_
 
autoPtr< vectorField3bEdgeContribution_
 
autoPtr< boundaryTensorFieldbdJdStressPtr_
 
autoPtr< volScalarFielddivDxDbMultPtr_
 
autoPtr< volTensorFieldgradDxDbMultPtr_
 
fileName objFunctionFolder_
 
autoPtr< OFstreamobjFunctionFilePtr_
 
autoPtr< OFstreaminstantValueFilePtr_
 
autoPtr< OFstreammeanValueFilePtr_
 
unsigned int width_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstreamreportingOutput
 
- Protected Member Functions inherited from objective
const dictionarydict () const
 
void setObjectiveFilePtr () const
 
void setInstantValueFilePtr () const
 
void setMeanValueFilePtr () const
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 
- 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
 

Detailed Description

Abstract base class for objective functions in incompressible flows.

Source files

Definition at line 50 of file objectiveIncompressible.H.

Constructor & Destructor Documentation

◆ objectiveIncompressible()

objectiveIncompressible ( const fvMesh mesh,
const dictionary dict,
const word adjointSolverName,
const word primalSolverName 
)

Definition at line 47 of file objectiveIncompressible.C.

References dict, and dictionary::get().

Here is the call graph for this function:

◆ ~objectiveIncompressible()

virtual ~objectiveIncompressible ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "incompressible"  )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
objectiveIncompressible  ,
dictionary  ,
(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)  ,
(mesh, dict, adjointSolverName, primalSolverName)   
)

◆ New()

autoPtr< objectiveIncompressible > New ( const fvMesh mesh,
const dictionary dict,
const word adjointSolverName,
const word primalSolverName 
)
static

Definition at line 90 of file objectiveIncompressible.C.

References dict, dictionary::dictName(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and mesh.

Here is the call graph for this function:

◆ J()

virtual scalar J ( )
pure virtual

Implements objective.

Implemented in objectiveNutSqr, objectiveMoment, objectiveForce, objectivePtLosses, and objectivePartialVolume.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ doNormalization()

void doNormalization ( )
virtual

◆ dJdv()

const volVectorField & dJdv ( )

Definition at line 185 of file objectiveIncompressible.C.

References objectiveIncompressible::dJdvPtr_, objective::mesh_, and Foam::type().

Here is the call graph for this function:

◆ dJdp()

const volScalarField & dJdp ( )

Definition at line 204 of file objectiveIncompressible.C.

References objectiveIncompressible::dJdpPtr_, objective::mesh_, and Foam::type().

Here is the call graph for this function:

◆ dJdT()

const volScalarField & dJdT ( )

Definition at line 223 of file objectiveIncompressible.C.

References objectiveIncompressible::dJdTPtr_, objective::mesh_, and Foam::type().

Here is the call graph for this function:

◆ dJdTMvar1()

const volScalarField & dJdTMvar1 ( )

Definition at line 242 of file objectiveIncompressible.C.

References objectiveIncompressible::dJdTMvar1Ptr_, objective::mesh_, and Foam::type().

Referenced by objectiveNutSqr::update_dJdTMvar1().

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

◆ dJdTMvar2()

const volScalarField & dJdTMvar2 ( )

Definition at line 261 of file objectiveIncompressible.C.

References objectiveIncompressible::dJdTMvar2Ptr_, objective::mesh_, and Foam::type().

Here is the call graph for this function:

◆ boundarydJdv() [1/2]

const fvPatchVectorField & boundarydJdv ( const label  patchI)

Definition at line 281 of file objectiveIncompressible.C.

◆ boundarydJdvn() [1/2]

const fvPatchScalarField & boundarydJdvn ( const label  patchI)

Definition at line 294 of file objectiveIncompressible.C.

◆ boundarydJdvt() [1/2]

const fvPatchVectorField & boundarydJdvt ( const label  patchI)

Definition at line 307 of file objectiveIncompressible.C.

◆ boundarydJdp() [1/2]

const fvPatchVectorField & boundarydJdp ( const label  patchI)

Definition at line 320 of file objectiveIncompressible.C.

◆ boundarydJdT() [1/2]

const fvPatchScalarField & boundarydJdT ( const label  patchI)

Definition at line 333 of file objectiveIncompressible.C.

◆ boundarydJdTMvar1() [1/2]

const fvPatchScalarField & boundarydJdTMvar1 ( const label  patchI)

Definition at line 346 of file objectiveIncompressible.C.

◆ boundarydJdTMvar2() [1/2]

const fvPatchScalarField & boundarydJdTMvar2 ( const label  patchI)

Definition at line 359 of file objectiveIncompressible.C.

◆ boundarydJdv() [2/2]

const boundaryVectorField & boundarydJdv ( )

Definition at line 371 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdvPtr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::velocitySource().

Here is the caller graph for this function:

◆ boundarydJdvn() [2/2]

const boundaryScalarField & boundarydJdvn ( )

Definition at line 381 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdvnPtr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::pressureSource().

Here is the caller graph for this function:

◆ boundarydJdvt() [2/2]

const boundaryVectorField & boundarydJdvt ( )

Definition at line 391 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdvtPtr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::tangentVelocitySource().

Here is the caller graph for this function:

◆ boundarydJdp() [2/2]

const boundaryVectorField & boundarydJdp ( )

Definition at line 401 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdpPtr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::normalVelocitySource().

Here is the caller graph for this function:

◆ boundarydJdT() [2/2]

const boundaryScalarField & boundarydJdT ( )

Definition at line 411 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdTPtr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::energySource().

Here is the caller graph for this function:

◆ boundarydJdTMvar1() [2/2]

const boundaryScalarField & boundarydJdTMvar1 ( )

Definition at line 421 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdTMvar1Ptr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::adjointTMVariable1Source().

Here is the caller graph for this function:

◆ boundarydJdTMvar2() [2/2]

const boundaryScalarField & boundarydJdTMvar2 ( )

Definition at line 431 of file objectiveIncompressible.C.

References objectiveIncompressible::bdJdTMvar2Ptr_, and objective::mesh_.

Referenced by boundaryAdjointContributionIncompressible::adjointTMVariable2Source().

Here is the caller graph for this function:

◆ update()

void update ( )
virtual

◆ nullify()

void nullify ( )
virtual

◆ update_dJdv()

virtual void update_dJdv ( )
inlinevirtual

Definition at line 235 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdp()

virtual void update_dJdp ( )
inlinevirtual

Definition at line 238 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdT()

virtual void update_dJdT ( )
inlinevirtual

Definition at line 241 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdTMvar1()

virtual void update_dJdTMvar1 ( )
inlinevirtual

Reimplemented in objectiveNutSqr.

Definition at line 244 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdTMvar2()

virtual void update_dJdTMvar2 ( )
inlinevirtual

Definition at line 247 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdb()

virtual void update_dJdb ( )
inlinevirtual

Definition at line 250 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_divDxDbMultiplier()

virtual void update_divDxDbMultiplier ( )
inlinevirtual

Reimplemented from objective.

Reimplemented in objectiveNutSqr.

Definition at line 253 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_gradDxDbMultiplier()

virtual void update_gradDxDbMultiplier ( )
inlinevirtual

Reimplemented from objective.

Definition at line 256 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdv()

virtual void update_boundarydJdv ( )
inlinevirtual

Reimplemented in objectivePtLosses.

Definition at line 259 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdvn()

virtual void update_boundarydJdvn ( )
inlinevirtual

Reimplemented in objectivePtLosses.

Definition at line 262 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdvt()

virtual void update_boundarydJdvt ( )
inlinevirtual

Reimplemented in objectivePtLosses.

Definition at line 265 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdp()

virtual void update_boundarydJdp ( )
inlinevirtual

Reimplemented in objectiveMoment, objectiveForce, and objectivePtLosses.

Definition at line 268 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdT()

virtual void update_boundarydJdT ( )
inlinevirtual

Definition at line 271 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdTMvar1()

virtual void update_boundarydJdTMvar1 ( )
inlinevirtual

Definition at line 274 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdTMvar2()

virtual void update_boundarydJdTMvar2 ( )
inlinevirtual

Definition at line 277 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_boundarydJdb()

virtual void update_boundarydJdb ( )
inlinevirtual

Reimplemented from objective.

Definition at line 280 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dSdbMultiplier()

virtual void update_dSdbMultiplier ( )
inlinevirtual

Reimplemented from objective.

Reimplemented in objectiveMoment, objectiveForce, and objectivePartialVolume.

Definition at line 283 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dndbMultiplier()

virtual void update_dndbMultiplier ( )
inlinevirtual

Reimplemented from objective.

Definition at line 286 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dxdbMultiplier()

virtual void update_dxdbMultiplier ( )
inlinevirtual

Reimplemented from objective.

Reimplemented in objectiveMoment, and objectiveForce.

Definition at line 289 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dxdbDirectMultiplier()

virtual void update_dxdbDirectMultiplier ( )
inlinevirtual

Reimplemented from objective.

Reimplemented in objectiveMoment, and objectivePartialVolume.

Definition at line 292 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_meanValues()

virtual void update_meanValues ( )
inlinevirtual

Reimplemented in objectiveMoment.

Definition at line 300 of file objectiveIncompressible.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ write()

bool write ( const bool  valid = true) const
virtual

Reimplemented from objective.

Definition at line 542 of file objectiveIncompressible.C.

References objective::write().

Here is the call graph for this function:

◆ hasdJdv()

bool hasdJdv ( ) const
inline

Definition at line 26 of file objectiveIncompressibleI.H.

References bool, and objectiveIncompressible::dJdvPtr_.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasdJdp()

bool hasdJdp ( ) const
inline

Definition at line 32 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasdJdT()

bool hasdJdT ( ) const
inline

Definition at line 38 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasdJdTMVar1()

bool hasdJdTMVar1 ( ) const
inline

Definition at line 44 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasdJdTMVar2()

bool hasdJdTMVar2 ( ) const
inline

Definition at line 50 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdv()

bool hasBoundarydJdv ( ) const
inline

Definition at line 56 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdvn()

bool hasBoundarydJdvn ( ) const
inline

Definition at line 62 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdvt()

bool hasBoundarydJdvt ( ) const
inline

Definition at line 68 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdp()

bool hasBoundarydJdp ( ) const
inline

Definition at line 74 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdT()

bool hasBoundarydJdT ( ) const
inline

Definition at line 80 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdTMVar1()

bool hasBoundarydJdTMVar1 ( ) const
inline

Definition at line 86 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

◆ hasBoundarydJdTMVar2()

bool hasBoundarydJdTMVar2 ( ) const
inline

Definition at line 92 of file objectiveIncompressibleI.H.

References bool.

Referenced by objectiveIncompressible::doNormalization(), and objectiveIncompressible::nullify().

Here is the caller graph for this function:

Member Data Documentation

◆ vars_

const incompressibleVars& vars_
protected

◆ dJdvPtr_

autoPtr<volVectorField> dJdvPtr_
protected

◆ dJdpPtr_

autoPtr<volScalarField> dJdpPtr_
protected

◆ dJdTPtr_

autoPtr<volScalarField> dJdTPtr_
protected

◆ dJdTMvar1Ptr_

autoPtr<volScalarField> dJdTMvar1Ptr_
protected

◆ dJdTMvar2Ptr_

autoPtr<volScalarField> dJdTMvar2Ptr_
protected

◆ bdJdvPtr_

autoPtr<boundaryVectorField> bdJdvPtr_
protected

◆ bdJdvnPtr_

autoPtr<boundaryScalarField> bdJdvnPtr_
protected

◆ bdJdvtPtr_

autoPtr<boundaryVectorField> bdJdvtPtr_
protected

◆ bdJdpPtr_

autoPtr<boundaryVectorField> bdJdpPtr_
protected

◆ bdJdTPtr_

autoPtr<boundaryScalarField> bdJdTPtr_
protected

◆ bdJdTMvar1Ptr_

autoPtr<boundaryScalarField> bdJdTMvar1Ptr_
protected

◆ bdJdTMvar2Ptr_

autoPtr<boundaryScalarField> bdJdTMvar2Ptr_
protected

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