class for managing incompressible objective functions. More...

Inheritance diagram for objectiveManager:

Collaboration diagram for objectiveManager:

Public Member Functions
	TypeName ("objectiveManager")

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

	objectiveManager (const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
	Construct from components. More...

virtual	~objectiveManager ()=default
	Destructor. More...

virtual bool	readDict (const dictionary &dict)

void	updateNormalizationFactor ()
	Update objective function related values. More...

void	update ()
	Update objective function related values. More...

void	updateOrNullify ()
	Update contributions to adjoint if true, otherwise return nulls. More...

void	incrementIntegrationTimes (const scalar timeSpan)
	Increment integration times by the optimisation cycle time-span. More...

scalar	print ()
	Print to screen. More...

virtual bool	write (const bool valid=true) const
	Write objective function history. More...

void	updateAndWrite ()

PtrList< objective > &	getObjectiveFunctions ()
	Return reference to objective functions. More...

const PtrList< objective > &	getObjectiveFunctions () const
	Return constant reference to objective functions. More...

const word &	adjointSolverManagerName () const
	Return name of adjointSolverManager. More...

const word &	adjointSolverName () const
	Return name of the adjointSolver. More...

const word &	primalSolverName () const
	Return name of the primalSolver. More...

void	checkIntegrationTimes () const
	Check integration times for unsteady runs. More...

virtual void	addUaEqnSource (fvVectorMatrix &UaEqn)=0
	Add contribution to adjoint momentum PDEs. More...

virtual void	addPaEqnSource (fvScalarMatrix &paEqn)=0
	Add contribution to adjoint momentum PDEs. More...

virtual void	addTMEqn1Source (fvScalarMatrix &adjTMEqn1)=0
	Add contribution to first adjoint turbulence model PDE. More...

virtual void	addTMEqn2Source (fvScalarMatrix &adjTMEqn2)=0
	Add contribution to second adjoint turbulence model PDE. More...

virtual bool	writeData (Ostream &) const
	Pure virtual writeData function. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	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)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const Time &	time () const
	Return time. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return non-constant access to the class name read from header. More...

const string &	note () const
	Return the optional note. More...

string &	note ()
	Return non-constant access to the optional note. More...

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &is)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header. More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

Static Public Member Functions
static autoPtr< objectiveManager >	New (const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
	Return a reference to the selected turbulence model. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &aptr)

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)

template<class Type >
static Type &	store (tmp< Type > &tptr)

template<class Type >
static Type &	store (tmp< Type > &&tptr)

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class StringType >
static word	scopedName (StringType scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Protected Attributes
const fvMesh &	mesh_

const dictionary &	dict_

const word	adjointSolverName_

const word	primalSolverName_

PtrList< objective >	objectives_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

class for managing incompressible objective functions.

Source files

Definition at line 54 of file objectiveManager.H.

Constructor & Destructor Documentation

◆ objectiveManager()

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

Construct from components.

Definition at line 45 of file objectiveManager.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAll, dictionary::get(), Foam::Info, dictionary::New(), Foam::nl, List< T >::setSize(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~objectiveManager()

virtual ~objectiveManager ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "objectiveManager" )

◆ declareRunTimeSelectionTable()

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

◆ New()

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

static

Return a reference to the selected turbulence model.

Definition at line 108 of file objectiveManager.C.

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

Here is the call graph for this function:

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Definition at line 141 of file objectiveManager.C.

References dict, and objectiveManager::objectives_.

◆ updateNormalizationFactor()

void updateNormalizationFactor ( )

Update objective function related values.

Definition at line 155 of file objectiveManager.C.

References objectiveManager::objectives_.

Referenced by objectiveManager::updateAndWrite().

Here is the caller graph for this function:

◆ update()

void update ( )

Update objective function related values.

Definition at line 168 of file objectiveManager.C.

References objectiveManager::objectives_.

Referenced by objectiveManager::updateAndWrite().

Here is the caller graph for this function:

◆ updateOrNullify()

void updateOrNullify ( )

Update contributions to adjoint if true, otherwise return nulls.

Definition at line 178 of file objectiveManager.C.

References objectiveManager::objectives_.

◆ incrementIntegrationTimes()

void incrementIntegrationTimes ( const scalar timeSpan )

Increment integration times by the optimisation cycle time-span.

Definition at line 195 of file objectiveManager.C.

References objectiveManager::objectives_.

◆ print()

scalar print ( )

Print to screen.

Definition at line 206 of file objectiveManager.C.

References Foam::endl(), Foam::Info, Foam::nl, objectiveManager::objectives_, and Foam::Zero.

Referenced by adjointSolverManager::constraintValues(), adjointSolverManager::objectiveValue(), and objectiveManager::updateAndWrite().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( const bool valid = true ) const

virtual

Write objective function history.

Reimplemented from regIOobject.

Definition at line 225 of file objectiveManager.C.

References objectiveManager::objectives_.

Referenced by objectiveManager::updateAndWrite().

Here is the caller graph for this function:

◆ updateAndWrite()

void updateAndWrite ( )

Call all functions required prior to the solution of the adjoint equations

Definition at line 238 of file objectiveManager.C.

References objectiveManager::print(), objectiveManager::update(), objectiveManager::updateNormalizationFactor(), and objectiveManager::write().

Here is the call graph for this function:

◆ getObjectiveFunctions() [1/2]

PtrList< objective > & getObjectiveFunctions ( )

Return reference to objective functions.

Definition at line 247 of file objectiveManager.C.

References objectiveManager::objectives_.

Referenced by shapeSensitivities::accumulateDirectSensitivityIntegrand(), FIBase::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::addGeometricSens(), boundaryAdjointContributionIncompressible::adjointTMVariable1Source(), boundaryAdjointContributionIncompressible::adjointTMVariable2Source(), adjointSensitivity::computeGradDxDbMultiplier(), boundaryAdjointContributionIncompressible::energySource(), incompressiblePrimalSolver::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::normalVelocitySource(), boundaryAdjointContributionIncompressible::pressureSource(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), and boundaryAdjointContributionIncompressible::velocitySource().

Here is the caller graph for this function:

◆ getObjectiveFunctions() [2/2]

const PtrList< objective > & getObjectiveFunctions ( ) const

Return constant reference to objective functions.

Definition at line 253 of file objectiveManager.C.

References objectiveManager::objectives_.

◆ adjointSolverManagerName()

const word& adjointSolverManagerName ( ) const

Return name of adjointSolverManager.

◆ adjointSolverName()

const word & adjointSolverName ( ) const

Return name of the adjointSolver.

Definition at line 259 of file objectiveManager.C.

References objectiveManager::adjointSolverName_.

Referenced by adjointSensitivity::computeGradDxDbMultiplier(), and adjointSpalartAllmaras::distanceSensitivities().

Here is the caller graph for this function:

◆ primalSolverName()

const word & primalSolverName ( ) const

Return name of the primalSolver.

Definition at line 265 of file objectiveManager.C.

References objectiveManager::primalSolverName_.

◆ checkIntegrationTimes()

void checkIntegrationTimes ( ) const

Check integration times for unsteady runs.

Definition at line 271 of file objectiveManager.C.

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

Here is the call graph for this function:

◆ addUaEqnSource()

virtual void addUaEqnSource ( fvVectorMatrix & UaEqn )

pure virtual

Add contribution to adjoint momentum PDEs.

Implemented in objectiveManagerIncompressible.

◆ addPaEqnSource()

virtual void addPaEqnSource ( fvScalarMatrix & paEqn )

pure virtual

Add contribution to adjoint momentum PDEs.

Implemented in objectiveManagerIncompressible.

◆ addTMEqn1Source()

virtual void addTMEqn1Source ( fvScalarMatrix & adjTMEqn1 )

pure virtual

Add contribution to first adjoint turbulence model PDE.

Implemented in objectiveManagerIncompressible.

Referenced by adjointSpalartAllmaras::correct().

Here is the caller graph for this function:

◆ addTMEqn2Source()

virtual void addTMEqn2Source ( fvScalarMatrix & adjTMEqn2 )

pure virtual

Add contribution to second adjoint turbulence model PDE.

Implemented in objectiveManagerIncompressible.

◆ writeData()

virtual bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writeData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 186 of file objectiveManager.H.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 62 of file objectiveManager.H.

◆ dict_

const dictionary& dict_

protected

Definition at line 63 of file objectiveManager.H.

◆ adjointSolverName_

const word adjointSolverName_

protected

Definition at line 64 of file objectiveManager.H.

Referenced by objectiveManager::adjointSolverName().

◆ primalSolverName_

const word primalSolverName_

protected

Definition at line 65 of file objectiveManager.H.

Referenced by objectiveManager::primalSolverName().

◆ objectives_

PtrList<objective> objectives_

protected

Definition at line 66 of file objectiveManager.H.

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

src/optimisation/adjointOptimisation/adjoint/objectiveManager/objectiveManager/objectiveManager.H
src/optimisation/adjointOptimisation/adjoint/objectiveManager/objectiveManager/objectiveManager.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ objectiveManager()

◆ ~objectiveManager()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ readDict()

◆ updateNormalizationFactor()

◆ update()

◆ updateOrNullify()

◆ incrementIntegrationTimes()

◆ print()

◆ write()

◆ updateAndWrite()

◆ getObjectiveFunctions() [1/2]

◆ getObjectiveFunctions() [2/2]

◆ adjointSolverManagerName()

◆ adjointSolverName()

◆ primalSolverName()

◆ checkIntegrationTimes()

◆ addUaEqnSource()

◆ addPaEqnSource()

◆ addTMEqn1Source()

◆ addTMEqn2Source()

◆ writeData()

Member Data Documentation

◆ mesh_

◆ dict_

◆ adjointSolverName_

◆ primalSolverName_

◆ objectives_