Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors. More...

Inheritance diagram for objective:

[legend]

Collaboration diagram for objective:

[legend]

Public Member Functions
	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)

virtual scalar	J ()=0

scalar	JCycle () const

void	accumulateJMean (solverControl &solverControl)

void	accumulateJMean ()

scalar	weight () const

bool	normalize () const

virtual void	doNormalization ()

bool	isWithinIntegrationTime () const

void	incrementIntegrationTimes (const scalar timeSpan)

const volScalarField &	dJdb ()

const fvPatchVectorField &	boundarydJdb (const label)

const fvPatchVectorField &	dSdbMultiplier (const label)

const fvPatchVectorField &	dndbMultiplier (const label)

const fvPatchVectorField &	dxdbMultiplier (const label)

const fvPatchVectorField &	dxdbDirectMultiplier (const label)

const vectorField &	boundaryEdgeMultiplier (const label patchI, const label edgeI)

const fvPatchTensorField &	boundarydJdStress (const label)

const boundaryVectorField &	boundarydJdb ()

const boundaryVectorField &	dSdbMultiplier ()

const boundaryVectorField &	dndbMultiplier ()

const boundaryVectorField &	dxdbMultiplier ()

const boundaryVectorField &	dxdbDirectMultiplier ()

const vectorField3 &	boundaryEdgeMultiplier ()

const boundaryTensorField &	boundarydJdStress ()

const volScalarField &	divDxDbMultiplier ()

const volTensorField &	gradDxDbMultiplier ()

virtual void	update ()=0

virtual void	nullify ()

virtual void	updateNormalizationFactor ()

virtual void	update_boundarydJdb ()

virtual void	update_dSdbMultiplier ()

virtual void	update_dndbMultiplier ()

virtual void	update_dxdbMultiplier ()

virtual void	update_dxdbDirectMultiplier ()

virtual void	update_boundaryEdgeContribution ()

virtual void	update_dJdStressMultiplier ()

virtual void	update_divDxDbMultiplier ()

virtual void	update_gradDxDbMultiplier ()

virtual bool	write (const bool valid=true) const

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 word &	objectiveName () 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 word &	name () 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 dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

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< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () 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 fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () 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< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () 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< dictionary >	clone () const

virtual	~dictionary ()

const fileName &	name () const noexcept

fileName &	name () noexcept

word	dictName () const

fileName	relativeName (const bool caseTag=false) const

bool	isNullDict () const noexcept

const dictionary &	parent () const noexcept

const dictionary &	topDict () 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

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const

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

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

dictionary &	subDictOrAdd (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 dictionary &	optionalSubDict (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< keyType >	keys (bool patterns=false) const

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)

entry *	add (entry *entryPtr, bool mergeEntry=false)

entry *	add (const entry &e, bool mergeEntry=false)

entry *	add (const keyType &k, const word &v, bool overwrite=false)

entry *	add (const keyType &k, const string &v, bool overwrite=false)

entry *	add (const keyType &k, const label v, bool overwrite=false)

entry *	add (const keyType &k, const scalar v, bool overwrite=false)

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)

entry *	set (entry *entryPtr)

entry *	set (const entry &e)

entry *	set (const keyType &k, const dictionary &v)

template<class T >
entry *	set (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 dictionary *	cfindScopedDict (const fileName &dictPath) const

const dictionary *	findScopedDict (const fileName &dictPath) const

dictionary *	findScopedDict (const fileName &dictPath)

dictionary *	makeScopedDict (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 entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)

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

ITstream &	operator[] (const word &keyword) const

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const

const dictionary *	subDictPtr (const word &keyword) const

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const

ITstream &	lookup (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::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
	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< objective >	New (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 Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept

static int	reportOptional (const int level) noexcept

static autoPtr< dictionary >	New (Istream &is)

Protected Member Functions
const dictionary &	dict () 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)

Protected Attributes
const fvMesh &	mesh_

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< volScalarField >	dJdbPtr_

autoPtr< boundaryVectorField >	bdJdbPtr_

autoPtr< boundaryVectorField >	bdSdbMultPtr_

autoPtr< boundaryVectorField >	bdndbMultPtr_

autoPtr< boundaryVectorField >	bdxdbMultPtr_

autoPtr< boundaryVectorField >	bdxdbDirectMultPtr_

autoPtr< vectorField3 >	bEdgeContribution_

autoPtr< boundaryTensorField >	bdJdStressPtr_

autoPtr< volScalarField >	divDxDbMultPtr_

autoPtr< volTensorField >	gradDxDbMultPtr_

fileName	objFunctionFolder_

autoPtr< OFstream >	objFunctionFilePtr_

autoPtr< OFstream >	instantValueFilePtr_

autoPtr< OFstream >	meanValueFilePtr_

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< fileCheckTypes >	fileCheckTypesNames

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< OSstream >	reportingOutput

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. No point in making this runTime selectable since its children will have different constructors.

Source files

Definition at line 55 of file objective.H.

Constructor & Destructor Documentation

◆ objective()

objective	(	const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	adjointSolverName,
		const word &	primalSolverName
	)

Definition at line 96 of file objective.C.

References dict, dictionary::found(), dictionary::get(), dictionary::readIfPresent(), and Foam::Zero.

Here is the call graph for this function:

◆ ~objective()

virtual ~objective ( )

virtualdefault

Member Function Documentation

◆ dict()

const dictionary & dict ( ) const

protected

Definition at line 87 of file objective.C.

References objective::dict_.

Referenced by objectivePtLosses::initialize(), and objective::readDict().

Here is the caller graph for this function:

◆ setObjectiveFilePtr()

void setObjectiveFilePtr ( ) const

protected

Definition at line 52 of file objective.C.

References objective::adjointSolverName_, objective::objectiveName_, objective::objFunctionFilePtr_, and objective::objFunctionFolder_.

Referenced by objective::write().

Here is the caller graph for this function:

◆ setInstantValueFilePtr()

void setInstantValueFilePtr ( ) const

protected

Definition at line 61 of file objective.C.

References objective::adjointSolverName_, objective::instantValueFilePtr_, objective::objectiveName_, and objective::objFunctionFolder_.

Referenced by objective::writeInstantaneousValue().

Here is the caller graph for this function:

◆ setMeanValueFilePtr()

void setMeanValueFilePtr ( ) const

protected

Definition at line 73 of file objective.C.

References objective::adjointSolverName_, objective::meanValueFilePtr_, objective::objectiveName_, and objective::objFunctionFolder_.

Referenced by objective::writeMeanValue().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "objective" )

◆ declareRunTimeNewSelectionTable()

declareRunTimeNewSelectionTable	(	autoPtr	,
		objective	,
		objective	,
		(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)	,
		(mesh, dict, adjointSolverName, primalSolverName)
	)

◆ New()

autoPtr< objective > New	(	const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	objectiveType,
		const word &	adjointSolverName,
		const word &	primalSolverName
	)

static

Definition at line 199 of file objective.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh.

Referenced by objectiveManager::objectiveManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Definition at line 235 of file objective.C.

References objective::dict(), and objective::dict_.

Here is the call graph for this function:

◆ J()

virtual scalar J ( )

pure virtual

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

Referenced by objective::JCycle().

Here is the caller graph for this function:

◆ JCycle()

scalar JCycle ( ) const

Definition at line 242 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::valid().

Referenced by objective::updateNormalizationFactor(), and objective::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accumulateJMean() [1/2]

void accumulateJMean ( solverControl & solverControl )

Definition at line 279 of file objective.C.

References solverControl::averageIter(), solverControl::doAverageIter(), objective::J_, objective::JMean_, and Foam::Zero.

Here is the call graph for this function:

◆ accumulateJMean() [2/2]

void accumulateJMean ( )

Definition at line 296 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::value().

Here is the call graph for this function:

◆ weight()

scalar weight ( ) const

Definition at line 318 of file objective.C.

References objective::weight_.

◆ normalize()

bool normalize ( ) const

Definition at line 324 of file objective.C.

References objective::normalize_.

◆ doNormalization()

void doNormalization ( )

virtual

Reimplemented in objectiveIncompressible.

Definition at line 330 of file objective.C.

References objective::bdJdbPtr_, objective::bdJdStressPtr_, objective::bdndbMultPtr_, objective::bdSdbMultPtr_, objective::bdxdbDirectMultPtr_, objective::bdxdbMultPtr_, objective::bEdgeContribution_, objective::divDxDbMultPtr_, objective::dJdbPtr_, objective::gradDxDbMultPtr_, objective::hasBoundarydJdb(), objective::hasBoundarydJdStress(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isWithinIntegrationTime()

bool isWithinIntegrationTime ( ) const

Definition at line 380 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::value().

Referenced by objective::accumulateJMean().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ incrementIntegrationTimes()

void incrementIntegrationTimes ( const scalar timeSpan )

Definition at line 401 of file objective.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::integrationEndTimePtr_, and objective::integrationStartTimePtr_.

Here is the call graph for this function:

◆ dJdb()

const volScalarField & dJdb ( )

Definition at line 417 of file objective.C.

References objective::dJdbPtr_, objective::mesh_, and objective::objectiveName_.

◆ boundarydJdb() [1/2]

const fvPatchVectorField & boundarydJdb ( const label patchI )

Definition at line 437 of file objective.C.

References objective::bdJdbPtr_, and objective::mesh_.

◆ dSdbMultiplier() [1/2]

const fvPatchVectorField & dSdbMultiplier ( const label patchI )

Definition at line 447 of file objective.C.

References objective::bdSdbMultPtr_, and objective::mesh_.

◆ dndbMultiplier() [1/2]

const fvPatchVectorField & dndbMultiplier ( const label patchI )

Definition at line 457 of file objective.C.

References objective::bdndbMultPtr_, and objective::mesh_.

◆ dxdbMultiplier() [1/2]

const fvPatchVectorField & dxdbMultiplier ( const label patchI )

Definition at line 467 of file objective.C.

References objective::bdxdbMultPtr_, and objective::mesh_.

◆ dxdbDirectMultiplier() [1/2]

const fvPatchVectorField & dxdbDirectMultiplier ( const label patchI )

Definition at line 477 of file objective.C.

References objective::bdxdbDirectMultPtr_, and objective::mesh_.

◆ boundaryEdgeMultiplier() [1/2]

const vectorField & boundaryEdgeMultiplier	(	const label	patchI,
		const label	edgeI
	)

Definition at line 488 of file objective.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ boundarydJdStress() [1/2]

const fvPatchTensorField & boundarydJdStress ( const label patchI )

Definition at line 503 of file objective.C.

References objective::bdJdStressPtr_, and objective::mesh_.

◆ boundarydJdb() [2/2]

const boundaryVectorField & boundarydJdb ( )

Definition at line 513 of file objective.C.

References objective::bdJdbPtr_, and objective::mesh_.

◆ dSdbMultiplier() [2/2]

const boundaryVectorField & dSdbMultiplier ( )

Definition at line 523 of file objective.C.

References objective::bdSdbMultPtr_, and objective::mesh_.

◆ dndbMultiplier() [2/2]

const boundaryVectorField & dndbMultiplier ( )

Definition at line 533 of file objective.C.

References objective::bdndbMultPtr_, and objective::mesh_.

◆ dxdbMultiplier() [2/2]

const boundaryVectorField & dxdbMultiplier ( )

Definition at line 543 of file objective.C.

References objective::bdxdbMultPtr_, and objective::mesh_.

◆ dxdbDirectMultiplier() [2/2]

const boundaryVectorField & dxdbDirectMultiplier ( )

Definition at line 553 of file objective.C.

References objective::bdxdbDirectMultPtr_, and objective::mesh_.

◆ boundaryEdgeMultiplier() [2/2]

const vectorField3 & boundaryEdgeMultiplier ( )

Definition at line 563 of file objective.C.

References objective::bdxdbDirectMultPtr_, objective::bEdgeContribution_, Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ boundarydJdStress() [2/2]

const boundaryTensorField & boundarydJdStress ( )

Definition at line 576 of file objective.C.

References objective::bdJdStressPtr_, and objective::mesh_.

◆ divDxDbMultiplier()

const volScalarField & divDxDbMultiplier ( )

Definition at line 586 of file objective.C.

References Foam::dimless, objective::divDxDbMultPtr_, objective::mesh_, and objective::objectiveName_.

◆ gradDxDbMultiplier()

const volTensorField & gradDxDbMultiplier ( )

Definition at line 607 of file objective.C.

References Foam::dimLength, Foam::dimTime, objective::gradDxDbMultPtr_, objective::mesh_, objective::objectiveName_, Foam::pow2(), and Foam::pow3().

Here is the call graph for this function:

◆ update()

virtual void update ( )

pure virtual

Implemented in objectiveIncompressible.

◆ nullify()

void nullify ( )

virtual

Reimplemented in objectiveIncompressible.

Definition at line 627 of file objective.C.

References objective::bdJdbPtr_, objective::bdJdStressPtr_, objective::bdndbMultPtr_, objective::bdSdbMultPtr_, objective::bdxdbDirectMultPtr_, objective::bdxdbMultPtr_, objective::bEdgeContribution_, objective::divDxDbMultPtr_, objective::dJdbPtr_, field(), objective::gradDxDbMultPtr_, objective::hasBoundarydJdb(), objective::hasBoundarydJdStress(), objective::hasBoundaryEdgeContribution(), objective::hasDivDxDbMult(), objective::hasdJdb(), objective::hasdndbMult(), objective::hasdSdbMult(), objective::hasdxdbDirectMult(), objective::hasdxdbMult(), objective::hasGradDxDbMult(), objective::nullified_, VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Referenced by objectiveIncompressible::nullify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateNormalizationFactor()

void updateNormalizationFactor ( )

virtual

Definition at line 270 of file objective.C.

References objective::JCycle(), objective::normalize_, objective::normFactor_, and autoPtr::reset().

Here is the call graph for this function:

◆ update_boundarydJdb()

virtual void update_boundarydJdb ( )

inlinevirtual

Reimplemented in objectiveIncompressible.

Definition at line 337 of file objective.H.

◆ update_dSdbMultiplier()

virtual void update_dSdbMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible, objectiveMoment, objectiveForce, and objectivePartialVolume.

Definition at line 341 of file objective.H.

◆ update_dndbMultiplier()

virtual void update_dndbMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible.

Definition at line 345 of file objective.H.

◆ update_dxdbMultiplier()

virtual void update_dxdbMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible, objectiveMoment, and objectiveForce.

Definition at line 349 of file objective.H.

◆ update_dxdbDirectMultiplier()

virtual void update_dxdbDirectMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible, objectiveMoment, and objectivePartialVolume.

Definition at line 354 of file objective.H.

◆ update_boundaryEdgeContribution()

virtual void update_boundaryEdgeContribution ( )

inlinevirtual

Definition at line 358 of file objective.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_dJdStressMultiplier()

virtual void update_dJdStressMultiplier ( )

inlinevirtual

Reimplemented in objectiveForce.

Definition at line 362 of file objective.H.

Referenced by objectiveIncompressible::update().

Here is the caller graph for this function:

◆ update_divDxDbMultiplier()

virtual void update_divDxDbMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible, and objectiveNutSqr.

Definition at line 366 of file objective.H.

◆ update_gradDxDbMultiplier()

virtual void update_gradDxDbMultiplier ( )

inlinevirtual

Reimplemented in objectiveIncompressible.

Definition at line 370 of file objective.H.

◆ write()

bool write ( const bool valid = true ) const

virtual

Reimplemented from regIOobject.

Reimplemented in objectiveIncompressible.

Definition at line 682 of file objective.C.

References objective::addColumnValues(), objective::addHeaderColumns(), objective::addHeaderInfo(), Foam::endl(), OSstream::flags(), objective::J_, objective::JCycle(), UPstream::master(), objective::mesh_, objective::normalize_, objective::normFactor_, objective::objFunctionFilePtr_, objective::setObjectiveFilePtr(), Foam::setw(), objective::target_, fvMesh::time(), autoPtr::valid(), dimensioned::value(), and objective::width_.

Referenced by objectiveIncompressible::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeInstantaneousValue()

void writeInstantaneousValue ( ) const

virtual

Definition at line 726 of file objective.C.

References Foam::endl(), objective::instantValueFilePtr_, objective::J_, UPstream::master(), objective::mesh_, objective::setInstantValueFilePtr(), Foam::tab, fvMesh::time(), and dimensioned::value().

Here is the call graph for this function:

◆ writeInstantaneousSeparator()

void writeInstantaneousSeparator ( ) const

virtual

Definition at line 743 of file objective.C.

References Foam::endl(), objective::instantValueFilePtr_, and UPstream::master().

Here is the call graph for this function:

◆ writeMeanValue()

void writeMeanValue ( ) const

virtual

Definition at line 755 of file objective.C.

References objective::computeMeanFields_, Foam::endl(), objective::hasIntegrationEndTime(), objective::hasIntegrationStartTime(), objective::JMean_, UPstream::master(), objective::meanValueFilePtr_, objective::mesh_, objective::setMeanValueFilePtr(), Foam::tab, fvMesh::time(), and dimensioned::value().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Reimplemented from baseIOdictionary.

Definition at line 782 of file objective.C.

References objective::JMean_, objective::normFactor_, and os().

Here is the call graph for this function:

◆ addHeaderInfo()

void addHeaderInfo ( ) const

virtual

Reimplemented in objectivePartialVolume.

Definition at line 793 of file objective.C.

Referenced by objective::write().

Here is the caller graph for this function:

◆ addHeaderColumns()

void addHeaderColumns ( ) const

virtual

Reimplemented in objectivePtLosses.

Definition at line 799 of file objective.C.

Referenced by objective::write().

Here is the caller graph for this function:

◆ addColumnValues()

void addColumnValues ( ) const

virtual

Reimplemented in objectivePtLosses.

Definition at line 805 of file objective.C.

Referenced by objective::write().

Here is the caller graph for this function:

◆ objectiveName()

const Foam::word & objectiveName ( ) const

inline

Definition at line 26 of file objectiveI.H.

References objective::objectiveName_.

◆ hasdJdb()

bool hasdJdb ( ) const

inline

Definition at line 32 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasBoundarydJdb()

bool hasBoundarydJdb ( ) const

inline

Definition at line 38 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasdSdbMult()

bool hasdSdbMult ( ) const

inline

Definition at line 44 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasdndbMult()

bool hasdndbMult ( ) const

inline

Definition at line 50 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasdxdbMult()

bool hasdxdbMult ( ) const

inline

Definition at line 56 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasdxdbDirectMult()

bool hasdxdbDirectMult ( ) const

inline

Definition at line 62 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasBoundaryEdgeContribution()

bool hasBoundaryEdgeContribution ( ) const

inline

Definition at line 68 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasBoundarydJdStress()

bool hasBoundarydJdStress ( ) const

inline

Definition at line 86 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasDivDxDbMult()

bool hasDivDxDbMult ( ) const

inline

Definition at line 74 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasGradDxDbMult()

bool hasGradDxDbMult ( ) const

inline

Definition at line 80 of file objectiveI.H.

References bool.

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

Here is the caller graph for this function:

◆ hasIntegrationStartTime()

bool hasIntegrationStartTime ( ) const

inline

Definition at line 92 of file objectiveI.H.

References bool.

Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), objective::JCycle(), and objective::writeMeanValue().

Here is the caller graph for this function:

◆ hasIntegrationEndTime()

bool hasIntegrationEndTime ( ) const

inline

Definition at line 98 of file objectiveI.H.

References bool.

Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), objective::isWithinIntegrationTime(), objective::JCycle(), and objective::writeMeanValue().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 63 of file objective.H.

◆ dict_

dictionary dict_

protected

Definition at line 64 of file objective.H.

Referenced by objective::dict(), and objective::readDict().

◆ adjointSolverName_

const word adjointSolverName_

protected

Definition at line 65 of file objective.H.

Referenced by objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().

◆ primalSolverName_

const word primalSolverName_

protected

Definition at line 66 of file objective.H.

◆ objectiveName_

const word objectiveName_

protected

Definition at line 67 of file objective.H.

Referenced by objective::divDxDbMultiplier(), objective::dJdb(), objective::gradDxDbMultiplier(), objective::objectiveName(), objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().

◆ computeMeanFields_

bool computeMeanFields_

protected

Definition at line 68 of file objective.H.

Referenced by objective::JCycle(), objectiveMoment::update_meanValues(), and objective::writeMeanValue().

◆ nullified_

bool nullified_

protected

Definition at line 69 of file objective.H.

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

◆ normalize_

bool normalize_

protected

Definition at line 70 of file objective.H.

Referenced by objectiveIncompressible::doNormalization(), objective::doNormalization(), objective::JCycle(), objective::normalize(), objective::updateNormalizationFactor(), and objective::write().

◆ J_

scalar J_

protected

Definition at line 73 of file objective.H.

Referenced by objective::accumulateJMean(), objectivePartialVolume::J(), objectivePtLosses::J(), objectiveForce::J(), objectiveMoment::J(), objectiveNutSqr::J(), objective::JCycle(), objective::write(), and objective::writeInstantaneousValue().

◆ JMean_

scalar JMean_

protected

Definition at line 76 of file objective.H.

Referenced by objective::accumulateJMean(), objective::JCycle(), objective::writeData(), and objective::writeMeanValue().

◆ weight_

scalar weight_

protected

Definition at line 79 of file objective.H.

Referenced by objective::weight().

◆ normFactor_

autoPtr<scalar> normFactor_

protected

Definition at line 82 of file objective.H.

Referenced by objectiveIncompressible::doNormalization(), objective::doNormalization(), objective::JCycle(), objective::updateNormalizationFactor(), objective::write(), and objective::writeData().

◆ target_

autoPtr<scalar> target_

protected

Definition at line 87 of file objective.H.

Referenced by objective::JCycle(), and objective::write().

◆ integrationStartTimePtr_

autoPtr<scalar> integrationStartTimePtr_

protected

Definition at line 90 of file objective.H.

Referenced by objective::accumulateJMean(), objective::incrementIntegrationTimes(), and objective::isWithinIntegrationTime().

◆ integrationEndTimePtr_

autoPtr<scalar> integrationEndTimePtr_

protected

Definition at line 91 of file objective.H.

Referenced by objective::incrementIntegrationTimes(), and objective::isWithinIntegrationTime().

◆ dJdbPtr_

autoPtr<volScalarField> dJdbPtr_

protected

Definition at line 98 of file objective.H.

Referenced by objective::dJdb(), objective::doNormalization(), and objective::nullify().

◆ bdJdbPtr_

autoPtr<boundaryVectorField> bdJdbPtr_

protected

Definition at line 104 of file objective.H.

Referenced by objective::boundarydJdb(), objective::doNormalization(), and objective::nullify().

◆ bdSdbMultPtr_

autoPtr<boundaryVectorField> bdSdbMultPtr_

protected

Definition at line 107 of file objective.H.

Referenced by objective::doNormalization(), objective::dSdbMultiplier(), objective::nullify(), objectivePartialVolume::update_dSdbMultiplier(), objectiveForce::update_dSdbMultiplier(), and objectiveMoment::update_dSdbMultiplier().

◆ bdndbMultPtr_

autoPtr<boundaryVectorField> bdndbMultPtr_

protected

Definition at line 110 of file objective.H.

Referenced by objective::dndbMultiplier(), objective::doNormalization(), and objective::nullify().

◆ bdxdbMultPtr_

autoPtr<boundaryVectorField> bdxdbMultPtr_

protected

Definition at line 113 of file objective.H.

Referenced by objective::doNormalization(), objective::dxdbMultiplier(), objective::nullify(), objectiveForce::update_dxdbMultiplier(), and objectiveMoment::update_dxdbMultiplier().

◆ bdxdbDirectMultPtr_

autoPtr<boundaryVectorField> bdxdbDirectMultPtr_

protected

Definition at line 118 of file objective.H.

Referenced by objective::boundaryEdgeMultiplier(), objective::doNormalization(), objective::dxdbDirectMultiplier(), objective::nullify(), objectivePartialVolume::update_dxdbDirectMultiplier(), and objectiveMoment::update_dxdbDirectMultiplier().

◆ bEdgeContribution_

autoPtr<vectorField3> bEdgeContribution_

protected

Definition at line 123 of file objective.H.

Referenced by objective::boundaryEdgeMultiplier(), objective::doNormalization(), and objective::nullify().

◆ bdJdStressPtr_

autoPtr<boundaryTensorField> bdJdStressPtr_

protected

Definition at line 126 of file objective.H.

Referenced by objective::boundarydJdStress(), objective::doNormalization(), objective::nullify(), and objectiveForce::update_dJdStressMultiplier().

◆ divDxDbMultPtr_

autoPtr<volScalarField> divDxDbMultPtr_

protected

Definition at line 133 of file objective.H.

Referenced by objective::divDxDbMultiplier(), objective::doNormalization(), objective::nullify(), and objectiveNutSqr::update_divDxDbMultiplier().

◆ gradDxDbMultPtr_

autoPtr<volTensorField> gradDxDbMultPtr_

protected

Definition at line 136 of file objective.H.

Referenced by objective::doNormalization(), objective::gradDxDbMultiplier(), and objective::nullify().

◆ objFunctionFolder_

fileName objFunctionFolder_

protected

Definition at line 139 of file objective.H.

Referenced by objective::setInstantValueFilePtr(), objective::setMeanValueFilePtr(), and objective::setObjectiveFilePtr().

◆ objFunctionFilePtr_

autoPtr<OFstream> objFunctionFilePtr_

mutableprotected

Definition at line 142 of file objective.H.

Referenced by objectivePtLosses::addColumnValues(), objectivePtLosses::addHeaderColumns(), objectivePartialVolume::addHeaderInfo(), objective::setObjectiveFilePtr(), and objective::write().

◆ instantValueFilePtr_

autoPtr<OFstream> instantValueFilePtr_

mutableprotected

Definition at line 146 of file objective.H.

Referenced by objective::setInstantValueFilePtr(), objective::writeInstantaneousSeparator(), and objective::writeInstantaneousValue().

◆ meanValueFilePtr_

autoPtr<OFstream> meanValueFilePtr_

mutableprotected

Definition at line 150 of file objective.H.

Referenced by objective::setMeanValueFilePtr(), and objective::writeMeanValue().

◆ width_

unsigned int width_

protected

Definition at line 153 of file objective.H.

Referenced by objectivePtLosses::addColumnValues(), objectivePtLosses::addHeaderColumns(), objectivePartialVolume::addHeaderInfo(), and objective::write().

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

src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.H
src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.C
src/optimisation/adjointOptimisation/adjoint/objectives/objective/objectiveI.H

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ objective()

◆ ~objective()

Member Function Documentation

◆ dict()

◆ setObjectiveFilePtr()

◆ setInstantValueFilePtr()

◆ setMeanValueFilePtr()

◆ TypeName()

◆ declareRunTimeNewSelectionTable()

◆ New()

◆ readDict()

◆ J()

◆ JCycle()

◆ accumulateJMean() [1/2]

◆ accumulateJMean() [2/2]

◆ weight()

◆ normalize()

◆ doNormalization()

◆ isWithinIntegrationTime()

◆ incrementIntegrationTimes()

◆ dJdb()

◆ boundarydJdb() [1/2]

◆ dSdbMultiplier() [1/2]

◆ dndbMultiplier() [1/2]

◆ dxdbMultiplier() [1/2]

◆ dxdbDirectMultiplier() [1/2]

◆ boundaryEdgeMultiplier() [1/2]

◆ boundarydJdStress() [1/2]

◆ boundarydJdb() [2/2]

◆ dSdbMultiplier() [2/2]

◆ dndbMultiplier() [2/2]

◆ dxdbMultiplier() [2/2]

◆ dxdbDirectMultiplier() [2/2]

◆ boundaryEdgeMultiplier() [2/2]

◆ boundarydJdStress() [2/2]

◆ divDxDbMultiplier()

◆ gradDxDbMultiplier()

◆ update()

◆ nullify()

◆ updateNormalizationFactor()

◆ update_boundarydJdb()

◆ update_dSdbMultiplier()

◆ update_dndbMultiplier()

◆ update_dxdbMultiplier()

◆ update_dxdbDirectMultiplier()

◆ update_boundaryEdgeContribution()

◆ update_dJdStressMultiplier()

◆ update_divDxDbMultiplier()

◆ update_gradDxDbMultiplier()

◆ write()

◆ writeInstantaneousValue()

◆ writeInstantaneousSeparator()

◆ writeMeanValue()

◆ writeData()

◆ addHeaderInfo()

◆ addHeaderColumns()

◆ addColumnValues()

◆ objectiveName()

◆ hasdJdb()

◆ hasBoundarydJdb()

◆ hasdSdbMult()

◆ hasdndbMult()

◆ hasdxdbMult()

◆ hasdxdbDirectMult()

◆ hasBoundaryEdgeContribution()

◆ hasBoundarydJdStress()

◆ hasDivDxDbMult()

◆ hasGradDxDbMult()

◆ hasIntegrationStartTime()

◆ hasIntegrationEndTime()

Member Data Documentation

◆ mesh_

◆ dict_