Class for managing adjoint solvers, which may be more than one per operating point. More...

Inheritance diagram for adjointSolverManager:

Collaboration diagram for adjointSolverManager:

Public Member Functions
	TypeName ("adjointSolverManager")

	adjointSolverManager (fvMesh &mesh, const word &managerType, const dictionary &dict, bool overrideUseSolverName)
	Construct from components. More...

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

virtual bool	readDict (const dictionary &dict)

const word &	managerName () const
	Const access to the manager name. More...

const word &	primalSolverName () const
	Const access to the primal solver name. More...

const dictionary &	dict () const
	Const access to the construction dictionary. More...

const PtrList< adjointSolver > &	adjointSolvers () const
	Const access to adjoint solvers. More...

PtrList< adjointSolver > &	adjointSolvers ()
	Non-const access to adjoint solvers. More...

scalar	operatingPointWeight () const
	Const access to adjoint solvers. More...

label	nConstraints () const
	Number of adjoint solvers corresponding to constraints. More...

label	nObjectives () const
	Number of adjoint solvers corresponding to objectives. More...

label	nAdjointSolvers () const
	Total number of adjoint solvers. More...

virtual void	solveAdjointEquations ()

virtual tmp< scalarField >	aggregateSensitivities ()
	Aggregate sensitivities from various adjoint solvers. More...

virtual PtrList< scalarField >	constraintSensitivities ()
	Get constraint sensitivities. One scalarField per constraint. More...

void	computeAllSensitivities ()

void	clearSensitivities ()
	Clear sensitivity fields from all adjoint solvers. More...

scalar	objectiveValue ()
	Get objective value. More...

virtual tmp< scalarField >	constraintValues ()
	Get constraint values. More...

void	updatePrimalBasedQuantities (const word &name)
	Update fields related to primal solution. 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 isTimeObject=false)

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

	regIOobject (const regIOobject &rio, bool registerCopy)

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

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

virtual	~regIOobject ()
	Destructor. More...

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

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

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

bool	registered () const noexcept

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

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

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

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

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

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

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

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

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

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

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

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

void	close ()
	Close Istream. More...

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

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

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

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const

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

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

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

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

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

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

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

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

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

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

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

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

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

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

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

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

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

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

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

string &	note () noexcept
	Modifiable access to the optional note. More...

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

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

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

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

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

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

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

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

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

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

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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

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

const fileName &	rootPath () const
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

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

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

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

fileName	objectRelPath () const
	The object path relative to the root. More...

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

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

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

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

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

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

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

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

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

Protected Attributes
fvMesh &	mesh_

dictionary	dict_

const word	managerName_

const word	primalSolverName_

PtrList< adjointSolver >	adjointSolvers_

labelList	objectiveSolverIDs_

labelList	constraintSolverIDs_

scalar	operatingPointWeight_

Additional Inherited Members
Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

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

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

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

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

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

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

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

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

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

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

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

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

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

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

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

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

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

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

Detailed Description

Class for managing adjoint solvers, which may be more than one per operating point.

Source files

Definition at line 54 of file adjointSolverManager.H.

Constructor & Destructor Documentation

◆ adjointSolverManager()

adjointSolverManager	(	fvMesh &	mesh,
		const word &	managerType,
		const dictionary &	dict,
		bool	overrideUseSolverName
	)

Construct from components.

Definition at line 42 of file adjointSolverManager.C.

Here is the call graph for this function:

◆ ~adjointSolverManager()

virtual ~adjointSolverManager ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "adjointSolverManager" )

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Definition at line 132 of file adjointSolverManager.C.

References dict, baseIOdictionary::name(), adjointSolverManager::readDict(), solver::readDict(), and dictionary::subDict().

Referenced by adjointSolverManager::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ managerName()

const Foam::word & managerName ( ) const

Const access to the manager name.

Definition at line 148 of file adjointSolverManager.C.

◆ primalSolverName()

const Foam::word & primalSolverName ( ) const

Const access to the primal solver name.

Definition at line 154 of file adjointSolverManager.C.

◆ dict()

const Foam::dictionary & dict ( ) const

Const access to the construction dictionary.

Definition at line 160 of file adjointSolverManager.C.

Referenced by adjointSolverManager::adjointSolverManager().

Here is the caller graph for this function:

◆ adjointSolvers() [1/2]

const Foam::PtrList< Foam::adjointSolver > & adjointSolvers ( ) const

Const access to adjoint solvers.

Definition at line 167 of file adjointSolverManager.C.

◆ adjointSolvers() [2/2]

Foam::PtrList< Foam::adjointSolver > & adjointSolvers ( )

Non-const access to adjoint solvers.

Definition at line 174 of file adjointSolverManager.C.

◆ operatingPointWeight()

Foam::scalar operatingPointWeight ( ) const

Const access to adjoint solvers.

Definition at line 180 of file adjointSolverManager.C.

◆ nConstraints()

Foam::label nConstraints ( ) const

Number of adjoint solvers corresponding to constraints.

Definition at line 186 of file adjointSolverManager.C.

Referenced by adjointSolverManager::adjointSolverManager().

Here is the caller graph for this function:

◆ nObjectives()

Foam::label nObjectives ( ) const

Number of adjoint solvers corresponding to objectives.

Definition at line 192 of file adjointSolverManager.C.

Referenced by adjointSolverManager::adjointSolverManager().

Here is the caller graph for this function:

◆ nAdjointSolvers()

Foam::label nAdjointSolvers ( ) const

Total number of adjoint solvers.

Definition at line 198 of file adjointSolverManager.C.

◆ solveAdjointEquations()

void solveAdjointEquations ( )

virtual

Update objective function-related values and solve adjoint equations

Definition at line 204 of file adjointSolverManager.C.

References solver::solve().

Here is the call graph for this function:

◆ aggregateSensitivities()

Foam::tmp< Foam::scalarField > aggregateSensitivities ( )

virtual

Aggregate sensitivities from various adjoint solvers.

Definition at line 216 of file adjointSolverManager.C.

References UList< T >::empty(), tmp< T >::ref(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ constraintSensitivities()

Foam::PtrList< Foam::scalarField > constraintSensitivities ( )

virtual

Get constraint sensitivities. One scalarField per constraint.

Definition at line 240 of file adjointSolverManager.C.

References forAll, and PtrList< T >::set().

Here is the call graph for this function:

◆ computeAllSensitivities()

void computeAllSensitivities ( )

Compute sensitivities for all adjoint solvers (both objective- and constraint-related ones)

Definition at line 257 of file adjointSolverManager.C.

◆ clearSensitivities()

void clearSensitivities ( )

Clear sensitivity fields from all adjoint solvers.

Definition at line 266 of file adjointSolverManager.C.

◆ objectiveValue()

Foam::scalar objectiveValue ( )

Get objective value.

Definition at line 275 of file adjointSolverManager.C.

References objectiveManager::print(), and Foam::Zero.

Here is the call graph for this function:

◆ constraintValues()

Foam::tmp< Foam::scalarField > constraintValues ( )

virtual

Get constraint values.

Definition at line 289 of file adjointSolverManager.C.

References forAll, objectiveManager::print(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ updatePrimalBasedQuantities()

void updatePrimalBasedQuantities ( const word & name )

Update fields related to primal solution.

For instance, primal fields of adjoint turbulence models

Definition at line 307 of file adjointSolverManager.C.

References Foam::name().

Here is the call graph for this function:

◆ writeData()

virtual bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writeData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 178 of file adjointSolverManager.H.

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

Definition at line 73 of file adjointSolverManager.H.

Referenced by adjointSolverManager::adjointSolverManager().

◆ dict_

dictionary dict_

protected

Definition at line 75 of file adjointSolverManager.H.

◆ managerName_

const word managerName_

protected

Definition at line 77 of file adjointSolverManager.H.

◆ primalSolverName_

const word primalSolverName_

protected

Definition at line 79 of file adjointSolverManager.H.

Referenced by adjointSolverManager::adjointSolverManager().

◆ adjointSolvers_

PtrList<adjointSolver> adjointSolvers_

protected

Definition at line 81 of file adjointSolverManager.H.

Referenced by adjointSolverManager::adjointSolverManager().

◆ objectiveSolverIDs_

labelList objectiveSolverIDs_

protected

Definition at line 83 of file adjointSolverManager.H.

Referenced by adjointSolverManager::adjointSolverManager().

◆ constraintSolverIDs_

labelList constraintSolverIDs_

protected

Definition at line 85 of file adjointSolverManager.H.

Referenced by adjointSolverManager::adjointSolverManager().

◆ operatingPointWeight_

scalar operatingPointWeight_

protected

Definition at line 87 of file adjointSolverManager.H.

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

src/optimisation/adjointOptimisation/adjoint/solvers/adjointSolverManager/adjointSolverManager.H
src/optimisation/adjointOptimisation/adjoint/solvers/adjointSolverManager/adjointSolverManager.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjointSolverManager()

◆ ~adjointSolverManager()

Member Function Documentation

◆ TypeName()

◆ readDict()

◆ managerName()

◆ primalSolverName()

◆ dict()

◆ adjointSolvers() [1/2]

◆ adjointSolvers() [2/2]

◆ operatingPointWeight()

◆ nConstraints()

◆ nObjectives()

◆ nAdjointSolvers()

◆ solveAdjointEquations()

◆ aggregateSensitivities()

◆ constraintSensitivities()

◆ computeAllSensitivities()

◆ clearSensitivities()

◆ objectiveValue()

◆ constraintValues()

◆ updatePrimalBasedQuantities()

◆ writeData()

Member Data Documentation

◆ mesh_

◆ dict_

◆ managerName_

◆ primalSolverName_

◆ adjointSolvers_

◆ objectiveSolverIDs_

◆ constraintSolverIDs_

◆ operatingPointWeight_