ISQP Class Reference

An L-BFGS-based SQP algorithm for computing the update of the design variables in the presence of inequality constraints. The QP problem is solved using the interior point method (hence the I in the classe name, which is not standard in the terminology used in the literature). The (potentially dense) linear system formulated by the interior point method is solved using Conjugate Gradient and a choice from three preconditioners (diagonal, inverse Hessian, Sherman-Morrison), using matrix-vector products to avoid storing the LHS matrix. More...

Inheritance diagram for ISQP:

Collaboration diagram for ISQP:

Public Types
enum	preconditioners { diag, invHessian, ShermanMorrison }
	Enumeration of preconditioners for the subproblem. More...
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char {   NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3,   LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true) More...
Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...
typedef Searcher< false >	searcher
	Searcher with non-const access. More...
Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values stored. More...
typedef T *	pointer
	Pointer for value_type. More...
typedef const T *	const_pointer
	Const pointer for value_type. More...
typedef T &	reference
	Reference for value_type. More...
typedef const T &	const_reference
	Const reference for value_type. More...
typedef label	size_type
	The type that can represent the container size. More...
typedef label	difference_type
	The difference between iterator objects. More...
using	base_iterator = typename LListBase::iterator
using	const_base_iterator = typename LListBase::const_iterator

Public Member Functions
	TypeName ("ISQP")
	Runtime type information. More...
	ISQP (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type)
	Construct from components. More...
virtual	~ISQP ()=default
	Destructor. More...
void	computeCorrection ()
	Compute design variables correction. More...
virtual scalar	computeMeritFunction ()
	Compute merit function. Could be different than the objective in the presence of constraints. More...
virtual scalar	meritFunctionDirectionalDerivative ()
	Derivative of the merit function. Could be different than the objective derivative in the presence of constraints. More...
virtual void	updateOldCorrection (const scalarField &oldCorrection)
	Update old correction. Useful for quasi-Newton methods coupled with line search. More...
virtual bool	writeData (Ostream &os) const
	Write useful quantities to files. More...
virtual bool	writeAuxiliaryData ()
	Write merit function information. More...
Public Member Functions inherited from LBFGS
	TypeName ("LBFGS")
	Runtime type information. More...
	LBFGS (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type)
	Construct from components. More...
virtual	~LBFGS ()=default
	Destructor. More...
Public Member Functions inherited from quasiNewton
	TypeName ("quasiNewton")
	Runtime type information. More...
	quasiNewton (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type)
	Construct from components. More...
virtual	~quasiNewton ()=default
	Destructor. More...
void	computeCorrection ()
	Compute design variables correction. More...
Public Member Functions inherited from updateMethod
	TypeName ("updateMethod")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, updateMethod, dictionary,(const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type),(mesh, dict, designVars, nConstraints, type))
	updateMethod (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type)
	Construct from components. More...
virtual	~updateMethod ()=default
	Destructor. More...
dictionary	coeffsDict (const word &type) const
	Return optional dictionary with parameters specific to each method. More...
void	setObjectiveDeriv (const scalarField &derivs)
	Set objective derivative. More...
void	setConstraintDeriv (const PtrList< scalarField > &derivs)
	Set constraints derivative. More...
void	setObjectiveValue (const scalar value)
	Set objective value. More...
void	setObjectiveValueOld (const scalar value)
	Set old objective value. More...
void	setConstraintValues (const scalarField &values)
	Set values of constraints. More...
scalar	getObjectiveValue () const
	Get objective value. More...
scalar	getObjectiveValueOld () const
	Get old objective value. More...
const scalarField &	getConstraintValues () const
	Get values of constraints. More...
label	getCycle () const
	Get optimisation cycle. More...
void	setStep (const scalar eta)
	Set step for optimisation methods. More...
void	modifyStep (const scalar multiplier)
	Multiply step. More...
void	setGlobalSum (const bool useGlobalSum)
	Set globalSum variable. More...
void	setConstaintsNumber (const label nConstraints)
	Set the number of constraints. More...
label	nConstraints () const
	Get the number of constraints. More...
scalarField &	returnCorrection ()
	Return the correction of the design variables. More...
void	writeCorrection ()
bool &	initialEtaSet ()
	Return whether initial eta was set. More...
Public Member Functions inherited from localIOdictionary
	localIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
	Construct given an IOobject and optional fallback dictionary content. More...
	localIOdictionary (const IOobject &io, const dictionary &dict)
	Construct given an IOobject and fallback dictionary content. More...
	localIOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
	Construct given an IOobject, wanted typeName and optional fallback dictionary content. More...
	localIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream. More...
virtual	~localIOdictionary ()=default
	Destructor. More...
virtual bool	global () const
	Is object global. More...
virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...
Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...
	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...
	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...
virtual	~baseIOdictionary ()=default
	Destructor. More...
	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
	Construct given an IOobject and optional fallback dictionary content (ununsed) More...
	baseIOdictionary (const IOobject &io, const dictionary &dict)
	Construct given an IOobject and fallback dictionary content (ununsed) More...
	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed) More...
const word &	name () const
	Name function is needed to disambiguate those inherited from regIOobject and dictionary. More...
virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...
void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...
void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. More...
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment. More...
	TypeName ("regIOobject")
	Runtime type information. More...
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
	regIOobject (const regIOobject &rio)
	Copy construct. More...
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true. More...
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
	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
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry? More...
bool	store ()
	Register object with its registry and transfer ownership to the registry. More...
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...
bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given. More...
void	close ()
	Close Istream. 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
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options. More...
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB. More...
void	operator= (const IOobject &io)
	Copy assignment. More...
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) 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, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options. More...
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option. 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 noexcept
	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...
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...
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. 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...
word	group () const
	Return group (extension part of name) More...
word	member () const
	Return member (name without the extension) More...
const fileName &	rootPath () const noexcept
	Return the Time::rootPath() More...
const fileName &	caseName () const noexcept
	Return the Time::caseName() More...
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName() 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 for the object (with instance, local,...). More...
fileName	globalPath () const
	The complete global path for the object (with instance, local,...) More...
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local. More...
fileName	objectPath () const
	The complete path + object name. More...
fileName	globalObjectPath () const
	The complete global 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
	Redirect to fileHandler filePath, searching locally. More...
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel. More...
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. More...
template<class Type >
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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
	Write header into a dictionary with current type() and given output format. More...
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format. More...
bool	good () const noexcept
	Did last readHeader() succeed? More...
bool	bad () const noexcept
	Did last readHeader() fail? More...
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream. More...
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) 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)
template<class Type >
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options. More...
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options. More...
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option. More...
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool. More...
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
readOption	readOpt () const noexcept
	Get the read option. More...
readOption	readOpt (readOption opt) noexcept
	Set the read option. More...
writeOption	writeOpt () const noexcept
	Get the write option. More...
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option. More...
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered? More...
bool	registerObject (bool on) noexcept
	Change registration preference. More...
bool	globalObject () const noexcept
	True if object is treated the same for all processors. More...
bool	globalObject (bool on) noexcept
	Change global-object status. More...
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ) More...
bool	isReadRequired () const noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set. More...
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. 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...
Public Member Functions inherited from dictionary
	ClassName ("dictionary")
	dictionary ()
	Default construct, a top-level empty dictionary. More...
	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...
	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
	Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header. More...
	dictionary (Istream &is)
	Construct top-level dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
	dictionary (Istream &is, bool keepHeader)
	Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header. More...
	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...
	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...
	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...
	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...
	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...
autoPtr< dictionary >	clone () const
	Construct and return clone. More...
virtual	~dictionary ()
	Destructor. More...
const fileName &	name () const noexcept
	The dictionary name. More...
fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...
word	dictName () const
	The local dictionary name (final part of scoped name) More...
fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...
bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...
const dictionary &	parent () const noexcept
	Return the parent dictionary. More...
const dictionary &	topDict () const
	Return the top of the tree. More...
label	startLineNumber () const
	Return line number of first token in dictionary. More...
label	endLineNumber () const
	Return line number of last token in dictionary. More...
SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...
tokenList	tokens () const
	Return the dictionary as a list of tokens. More...
const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...
entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find an entry (non-const access) with the given keyword. More...
bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...
const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...
const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More...
dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More...
bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find a sub-dictionary. More...
const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...
ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return an entry data stream. FatalIOError if not found, or not a stream. More...
template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect. More...
template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
	Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect. More...
template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
	Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...
dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...
dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...
dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
	Find and return a sub-dictionary as a copy, otherwise return an empty dictionary. More...
const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...
wordList	toc () const
	Return the table of contents. More...
wordList	sortedToc () const
	Return the sorted table of contents. More...
template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...
List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...
bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...
bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...
entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...
entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...
entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...
entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...
entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...
entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...
entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...
template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...
entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...
entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...
entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...
template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...
bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...
bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...
bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...
void	clear ()
	Clear the dictionary. More...
void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...
void	checkITstream (const ITstream &is, const word &keyword) const
	Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place. More...
bool	read (Istream &is)
	Read dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream (optionally keeping the header) Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...
void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...
void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...
void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...
const_searcher	csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword. More...
const_searcher	search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword. More...
searcher	search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Search dictionary for given keyword. More...
const_searcher	csearchScoped (const word &keyword, enum keyType::option matchOpt) const
	Search using scoping. More...
const_searcher	searchScoped (const word &keyword, enum keyType::option matchOpt) const
	Search using dot or slash scoping. More...
searcher	searchScoped (const word &keyword, enum keyType::option matchOpt)
	Search using dot or slash scoping. More...
const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...
const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...
dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...
dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...
const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...
const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
	Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed. More...
bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...
const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
	Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed. More...
ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return an entry data stream, using any compatibility names if needed. More...
template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens. More...
template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a T, or return the given default value using any compatibility names if needed. More...
template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
	Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens. More...
template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens. More...
void	operator= (const dictionary &rhs)
	Copy assignment. More...
void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...
void	operator|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...
void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...
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 T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
	Same as getOrDefault() More...
template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
	Same as getOrAdd() More...
ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) - use lookup() method. More...
bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...
entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...
const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...
const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...
const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...
dictionary *	subDictPtr (const word &keyword)
	Deprecated(2018-10) Find and return a sub-dictionary pointer if present. More...
const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...
ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...
template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...
template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...
template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...
template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...
template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const
template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)
template<class T >
Foam::entry *	set (const keyType &k, const T &v)
Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default construct. More...
	ILList (T *item)
	Construct and add initial item pointer. More...
	ILList (Istream &is)
	Construct from Istream. More...
	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...
	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...
template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...
template<class INew >
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...
	~ILList ()
	Destructor. Calls clear() More...
void	clear ()
	Clear the contents of the list. More...
void	pop_front (label n=1)
	Remove first element(s) from the list (deletes pointers) More...
bool	erase (T *item)
	Remove the specified element from the list and delete it. More...
void	transfer (ILList< LListBase, T > &lst)
	Transfer the contents of the argument into this List and annul the argument list. More...
void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...
void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...
Public Member Functions inherited from UILList< LListBase, T >
	UILList ()=default
	Default construct. More...
	UILList (T *item)
	Construct and add initial item pointer. More...
	UILList (const UILList< LListBase, T > &list)
	Construct as copy. More...
T *	front ()
	The first entry in the list. More...
const T *	front () const
	The first entry in the list (const access) More...
T *	back ()
	The last entry in the list. More...
const T *	back () const
	The last entry in the list (const access) More...
T *	removeHead ()
	Remove and return head. More...
T *	remove (T *item)
	Remove and return element. More...
T *	remove (iterator &iter)
	Remove and return item specified by iterator. More...
void	operator= (const UILList< LListBase, T > &lst)
	Copy assignment. More...
bool	operator== (const UILList< LListBase, T > &lst) const
	Equality. True both lists are element-wise equal. More...
bool	operator!= (const UILList< LListBase, T > &lst) const
	The opposite of the equality operation. Takes linear time. More...
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write UILList with line-breaks when length exceeds shortLen. More...
iterator	begin ()
	Iterator to first item in list with non-const access. More...
const_iterator	cbegin () const
	Iterator to first item in list with const access. More...
reverse_iterator	rbegin ()
	Iterator to last item in list with non-const access. More...
const_reverse_iterator	crbegin () const
	Iterator to last item in list with const access. More...
const_iterator	begin () const
	Iterator to first item in list with const access. More...
const_reverse_iterator	rbegin () const
	Iterator to last item in list with const access. More...
const iterator &	end ()
	End of list for forward iterators. More...
const const_iterator &	cend () const
	End of list for forward iterators. More...
const reverse_iterator &	rend ()
	End of list for reverse iterators. More...
const const_reverse_iterator &	crend () const
	End of list for reverse iterators. More...
const const_iterator &	end () const
	End of list for forward iterators. More...
const const_reverse_iterator &	rend () const
	End of list for reverse iterators. More...
T *	first ()
	The first entry in the list. More...
const T *	first () const
	The first entry in the list (const access) More...
T *	last ()
	The last entry in the list. More...
const T *	last () const
	The last entry in the list (const access) More...
Public Member Functions inherited from SQPBase
	TypeName ("SQPBase")
	Runtime type information. More...
	SQPBase (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const updateMethod &UpdateMethod, const word &type)
	Construct from components. More...
virtual	~SQPBase ()=default
	Destructor. More...
virtual bool	addToFile (Ostream &os) const
	Write continuation info. More...
virtual bool	writeMeritFunction (const updateMethod &UpdateMethod)
	Write info about the merit function. More...
Public Member Functions inherited from constrainedOptimisationMethod
	TypeName ("constrainedOptimisationMethod")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, constrainedOptimisationMethod, dictionary,(const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type),(mesh, dict, designVars, nConstraints, type))
	constrainedOptimisationMethod (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type)
	Construct from components. More...
virtual	~constrainedOptimisationMethod ()=default
	Destructor. More...

Static Public Attributes
static const Enum< preconditioners >	preconditionerNames
	Names of preconditioners for the subproblem. 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...
Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...
static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...
static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Protected Member Functions
void	updateSizes ()
	Update sizes of fields related to the active design variables. More...
void	allocateBoundMultipliers ()
	Allocate multipliers for the bound constraints. More...
void	allocateLagrangeMultipliers ()
	Allocate Lagrange multipliers for the inequality constraints. More...
void	updateYS ()
	Update the vectors accosiated with the Hessian matrix. More...
void	initialize ()
	Allocate fields related to constraints. More...
void	solveSubproblem ()
	Solve subproblem using a Newton optimiser. More...
void	computeNewtonDirection ()
	Compute direction for the Newton problem. More...
void	zeroUpdates ()
	Zero the updates computed in the previous optimisation cycle. More...
void	solveDeltaPEqn ()
	Solve the equation for deltaX, which is the expensive part of the Newtopn step. More...
tmp< scalarField >	computeRHSForDeltaX (const scalarField &FDx)
	Compute the RHS for the deltaX equation. More...
void	CGforDeltaP (const scalarField &FDx)
	CG algorithm for the solution of the deltaP eqn. More...
tmp< scalarField >	matrixVectorProduct (const scalarField &vector)
	Procudt of the LHS of the deltaP eqn with a vector. More...
tmp< scalarField >	preconVectorProduct (const scalarField &vector, autoPtr< scalarField > &precon)
	Preconditioner-vector product for CG. More...
tmp< scalarField >	diagPreconditioner ()
	Diagonal preconditioner of the deltaP eqn. More...
tmp< scalarField >	ShermanMorrisonPrecon (const scalarField &vector)
	Use the Sherman-Morrison formula to compute the matrix-free product of the approximate inverse of the LHS with a vector. More...
tmp< scalarField >	ShermanMorrisonRank1Update (const PtrList< scalarField > &r1Updates, const scalarField &p, const tmp< scalarField > &diag, const scalarField &mult, label n)
	Recursive (naive) implementation of the rank-1 update. More...
scalar	lineSearch ()
	Perform line search and return max residual corresponding to the updated solution. More...
void	adjustStep (scalar &step, const scalar value, const scalar update)
	Adjust step to satisfy cireteria. More...
void	updateSolution (const scalar step)
	Update the current solution using the known direction and the given step length. More...
tmp< scalarField >	computeResiduals ()
	Compute and return residuals based on the current solution. More...
tmp< scalarField >	resFL ()
	Residual of the gradient of the Lagrangian. More...
tmp< scalarField >	invHFL ()
	Product of the inverse Hessian with the residual of the gradient of the Lagrangian. More...
tmp< scalarField >	resFGs ()
	Residual of the inequality constraint slackness. More...
tmp< scalarField >	resFlamda ()
	Residual of the complementarity slackness for the inequality constraints. More...
tmp< scalarField >	resFls ()
	Residual of the lower bounds slackness. More...
tmp< scalarField >	resFus ()
	Residual of the upper bounds slackness. More...
tmp< scalarField >	resFlTilda ()
	Residual of the complementarity slackness for the lower bound constraints. More...
tmp< scalarField >	resFuTilda ()
	Residual of the complementarity slackness for the upper bound constraints. More...
tmp< scalarField >	resFExtraVars ()
	Residual of the Lagrangian derivative wrt the extra variables. More...
tmp< scalarField >	resFz ()
	Residual of the complementarity slackness for the extra variables. More...
void	storeOldFields ()
	Store old fields needed for the next iter. More...
virtual scalar	meritFunctionConstraintPart () const
	Get the part the merit function that depends on the constraints. More...
Protected Member Functions inherited from LBFGS
void	allocateVectors ()
	Allocate matrices in the first optimisation cycle. More...
void	pivotFields (PtrList< scalarField > &list, const scalarField &f)
	Move pointers in PtrList to the left and replace last element with given field. More...
void	updateVectors (const scalarField &derivatives, const scalarField &derivativesOld)
	Update y and s vectors. More...
void	applyDamping (scalarField &y, scalarField &s)
	Use the damped version of s to ensure positive-definitiveness. More...
virtual void	updateHessian ()
	Update the Hessian matrix by updating the base vectors. More...
virtual void	update ()
	Update design variables. More...
virtual tmp< scalarField >	invHessianVectorProduct (const scalarField &vector)
	Compute the inverse Hessian - vector product. More...
tmp< scalarField >	invHessianVectorProduct (const scalarField &vector, const label counter, tmp< scalarField > diag=nullptr)
	Same as previous one, but with an explicit counter provided. More...
virtual tmp< scalarField >	HessianVectorProduct (const scalarField &vector)
	Compute the Hessian - vector product. More...
tmp< scalarField >	HessianVectorProduct (const scalarField &vector, const label counter)
	Same as previous one, but with an explicit counter provided. More...
tmp< scalarField >	HessianDiag ()
	Return the diagonal of the Hessian. More...
virtual tmp< scalarField >	SR1HessianVectorProduct (const scalarField &vector)
	Compute the Hessian - vector product. More...
tmp< scalarField >	SR1HessianVectorProduct (const scalarField &vector, const label counter)
	Same as previous one, but with an explicit counter provided. More...
tmp< scalarField >	SR1HessianDiag ()
	Return the diagonal of the Hessian. More...
Protected Member Functions inherited from quasiNewton
void	allocateHessian ()
	Allocate the Hessian matrix. More...
Protected Member Functions inherited from updateMethod
const scalarField	leftMult (const scalarField &, const SquareMatrix< scalar > &)
const scalarField	rightMult (const SquareMatrix< scalar > &, const scalarField &)
SquareMatrix< scalar >	outerProd (const scalarField &, const scalarField &)
SquareMatrix< scalar >	inv (SquareMatrix< scalar > A)
scalar	globalSum (const scalarField &field)
	Compute either global or local sum, based on globalSum flag. More...
scalar	globalSum (tmp< scalarField > &tfield)
	Compute either global or local sum, based on globalSum flag. More...
label	globalSum (const label)
	Compute either global or local sum, based on globalSum flag. More...
tmp< scalarField >	readOrZeroField (const word &name, const label size)
	Helper function to either read a scalarField of certain size from a dictionary, or construct a zero field. More...
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
bool	doAllocateLagrangeMultipliers_
	Should Lagrange multipliers be allocated. More...
bool	includeBoundConstraints_
	Are bound constraints included? More...
bool	includeExtraVars_
	Are additional design variables included? More...
scalarField	p_
	The set of design variables being updated during the subproblem. More...
scalarField	gs_
	Slack variables for the inequality constraints. More...
autoPtr< scalarField >	lTilda_
	Lagrange multipliers for the lower bound constraints. More...
autoPtr< scalarField >	ls_
	Slack variables the lower bound constraints. More...
autoPtr< scalarField >	uTilda_
	Lagrange multipliers for the upper bound constraints. More...
autoPtr< scalarField >	us_
	Slack variables the upper bound constraints. More...
autoPtr< scalarField >	extraVars_
	Extra variables for finding solutions even in infeasible problems. More...
autoPtr< scalarField >	z_
	Lagrange multipliers for positive extra variables. More...
scalar	c_
	Multiplier of the additional variables y in the Lagrangian, to make them 'expensive'. More...
scalarField	deltaP_
scalarField	deltaLamda_
scalarField	deltaGs_
autoPtr< scalarField >	deltaLTilda_
autoPtr< scalarField >	deltaLs_
autoPtr< scalarField >	deltaUTilda_
autoPtr< scalarField >	deltaUs_
autoPtr< scalarField >	deltaExtraVars_
autoPtr< scalarField >	deltaZ_
scalar	eps_
	Infinitesimal quantity. More...
scalar	epsMin_
	Final eps quantity to be reached during the solution of the subproblem. More...
label	maxNewtonIters_
	Maxmimum number of Newton iterations for the subproblem. More...
label	maxLineSearchIters_
	Maxmimum number of line search iterations for each iteration of the subproblem. More...
label	maxDxIters_
	Maxmimum number of iterations for the deltaX equation. More...
scalar	relTol_
	Relative tolerance of the CG solver, solving for deltaP_. More...
label	preconType_
	Which preconditioner to use for the solution of the subproblem. More...
scalar	cRed_
	Percentage reduction for the constraints. More...
autoPtr< OFstream >	meritFunctionFile_
	File including the l1 merit function. More...
Protected Attributes inherited from LBFGS
label	nPrevSteps_
	Number of old corrections and grad differences kept. More...
PtrList< scalarField >	y_
	The previous differences of derivatives. Holds nPrevSteps_ fields. More...
PtrList< scalarField >	s_
	The previous correction. Holds nPrevSteps_ fields. More...
bool	useSDamping_
	Use damping for s to ensure positive-definitiveness. More...
bool	useYDamping_
	Use damping for s to ensure positive-definitiveness. More...
Protected Attributes inherited from quasiNewton
scalar	etaHessian_
	Step for the Newton method. More...
label	nSteepestDescent_
	Number of first steepest descent steps. More...
bool	scaleFirstHessian_
	Scale the initial unitary Hessian approximation. More...
autoPtr< SquareMatrix< scalar > >	Hessian_
	The Hessian or its inverse, depending on the deriving class. More...
scalarField	derivativesOld_
	The previous derivatives. More...
scalarField	correctionOld_
	The previous correction. More...
Protected Attributes inherited from updateMethod
const fvMesh &	mesh_
const dictionary	dict_
autoPtr< designVariables > &	designVars_
	Design variables. More...
label	nConstraints_
	Number of constraints. More...
const labelList &	activeDesignVars_
	Map to active design variables. More...
scalarField	objectiveDerivatives_
	Derivatives of the objective functions. More...
PtrList< scalarField >	constraintDerivatives_
	Derivatives of the constraints. More...
scalar	objectiveValue_
	Objective value. More...
scalar	objectiveValueOld_
	Old objective value. More...
scalarField	cValues_
	Constraint values. More...
scalarField	correction_
	Design variables correction. More...
scalarField	cumulativeCorrection_
	Cumulative design variables correction throughout the optimisation loop. More...
scalar	eta_
	Step multiplying the correction. More...
label	counter_
	Optimisation cycle count. More...
bool	initialEtaSet_
	Is initially set? More...
word	correctionFolder_
	Folder storing the corrections to file. More...
bool	globalSum_
	Whether to use gSum or sum in the inner products. More...
Protected Attributes inherited from SQPBase
scalarField	LagrangianDerivatives_
	Derivatives of the Lagrangian function. More...
List< scalarField >	constraintDerivativesOld_
	The previous constraint derivatives. More...
scalarField	lamdas_
	Lagrange multipliers. More...
fileName	objFunctionFolder_
	Name of the objective folder. More...
autoPtr< OFstream >	meritFunctionFile_
	File including the l1 merit function. More...
scalar	mu_
	Penalty value for the merit function. More...
scalar	delta_
	Safety factor. More...

Additional Inherited Members
Static Public Member Functions inherited from updateMethod
static autoPtr< updateMethod >	New (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints)
	Return a reference to the selected turbulence model. More...
Static Public Member Functions inherited from localIOdictionary
static dictionary	readContents (const IOobject &io)
	Read and return contents. The IOobject will not be registered. 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 word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string. More...
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ) More...
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set. More...
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...
static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...
static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...
Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...
friend	searcher
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information. More...
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information. More...
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

An L-BFGS-based SQP algorithm for computing the update of the design variables in the presence of inequality constraints. The QP problem is solved using the interior point method (hence the I in the classe name, which is not standard in the terminology used in the literature). The (potentially dense) linear system formulated by the interior point method is solved using Conjugate Gradient and a choice from three preconditioners (diagonal, inverse Hessian, Sherman-Morrison), using matrix-vector products to avoid storing the LHS matrix.

Bound constraints on the design variables will also be included, if set by the designVariables known by the updateMethod. If the QP problem is infeasible, the algorithm can still be used by setting includeExtraVars_ to true, to allow a computation of an update, despite not being able to satisfy all the constraints of the QP problem. Alternatively, targetConstraintReduction can be set to a number lower than 1 to help with the feasibility of the dual problem.

Source files

• ISQP.H
• ISQP.C

Definition at line 65 of file ISQP.H.

Member Enumeration Documentation

preconditioners

enum preconditioners

Enumeration of preconditioners for the subproblem.

Enumerator
diag
invHessian
ShermanMorrison

Definition at line 75 of file ISQP.H.

Constructor & Destructor Documentation

ISQP()

ISQP	(	const fvMesh &	mesh,
		const dictionary &	dict,
		autoPtr< designVariables > &	designVars,
		const label	nConstraints,
		const word &	type
	)

Construct from components.

Definition at line 994 of file ISQP.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

~ISQP()

virtual ~ISQP ( )

virtualdefault

Destructor.

Member Function Documentation

updateSizes()

void updateSizes ( )

protected

Update sizes of fields related to the active design variables.

Definition at line 57 of file ISQP.C.

References updateMethod::activeDesignVars_, ISQP::deltaLs_, ISQP::deltaLTilda_, ISQP::deltaP_, ISQP::deltaUs_, ISQP::deltaUTilda_, ISQP::includeBoundConstraints_, ISQP::ls_, ISQP::lTilda_, n, LBFGS::nPrevSteps_, ISQP::p_, LBFGS::s_, List< T >::setSize(), UList< T >::size(), ISQP::us_, ISQP::uTilda_, LBFGS::y_, and Foam::Zero.

Here is the call graph for this function:

allocateBoundMultipliers()

void allocateBoundMultipliers ( )

protected

Allocate multipliers for the bound constraints.

Definition at line 90 of file ISQP.C.

References n, and Foam::Zero.

allocateLagrangeMultipliers()

void allocateLagrangeMultipliers ( )

protected

Allocate Lagrange multipliers for the inequality constraints.

Definition at line 116 of file ISQP.C.

References Foam::max(), and Foam::Zero.

Here is the call graph for this function:

updateYS()

void updateYS ( )

protected

Update the vectors accosiated with the Hessian matrix.

Definition at line 134 of file ISQP.C.

References forAll.

initialize()

void initialize ( )

protected

Allocate fields related to constraints.

Definition at line 160 of file ISQP.C.

References Foam::max(), x, and Foam::Zero.

Here is the call graph for this function:

solveSubproblem()

void solveSubproblem ( )

protected

Solve subproblem using a Newton optimiser.

Definition at line 880 of file ISQP.C.

References addProfiling, Foam::ensightOutput::debug, DebugInfo, Foam::endl(), Foam::gMax(), Foam::gMin(), Foam::Info, Foam::mag(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

computeNewtonDirection()

void computeNewtonDirection ( )

protected

Compute direction for the Newton problem.

Definition at line 486 of file ISQP.C.

References addProfiling, and forAll.

zeroUpdates()

void zeroUpdates ( )

protected

Zero the updates computed in the previous optimisation cycle.

Definition at line 189 of file ISQP.C.

References Foam::Zero.

solveDeltaPEqn()

void solveDeltaPEqn ( )

protected

Solve the equation for deltaX, which is the expensive part of the Newtopn step.

All other corrections can be computed based on this

Definition at line 211 of file ISQP.C.

References addProfiling, and forAll.

computeRHSForDeltaX()

Foam::tmp< Foam::scalarField > computeRHSForDeltaX ( const scalarField &  FDx )

protected

Compute the RHS for the deltaX equation.

Currently not in use

Definition at line 243 of file ISQP.C.

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

Here is the call graph for this function:

CGforDeltaP()

void CGforDeltaP ( const scalarField &  FDx )

protected

CG algorithm for the solution of the deltaP eqn.

Definition at line 283 of file ISQP.C.

References addProfiling, beta(), DebugInfo, Foam::endl(), p, and Foam::sqrt().

Here is the call graph for this function:

matrixVectorProduct()

Foam::tmp< Foam::scalarField > matrixVectorProduct ( const scalarField &  vector )

protected

Procudt of the LHS of the deltaP eqn with a vector.

Definition at line 316 of file ISQP.C.

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

Here is the call graph for this function:

preconVectorProduct()

Foam::tmp< Foam::scalarField > preconVectorProduct ( const scalarField &  vector, autoPtr< scalarField > &  precon  )

protected

Preconditioner-vector product for CG.

In case a diagonal preconditioner is used, it is stored in precon for all CG iterations

Definition at line 359 of file ISQP.C.

References addProfiling, Foam::diag(), and autoPtr< T >::reset().

Here is the call graph for this function:

diagPreconditioner()

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

protected

Diagonal preconditioner of the deltaP eqn.

Definition at line 385 of file ISQP.C.

References addProfiling, forAll, tmp< T >::ref(), and Foam::sqr().

Here is the call graph for this function:

ShermanMorrisonPrecon()

Foam::tmp< Foam::scalarField > ShermanMorrisonPrecon ( const scalarField &  vector )

protected

Use the Sherman-Morrison formula to compute the matrix-free product of the approximate inverse of the LHS with a vector.

Definition at line 415 of file ISQP.C.

References forAll, tmp< T >::reset(), List< T >::set(), and UList< T >::size().

Here is the call graph for this function:

ShermanMorrisonRank1Update()

Foam::tmp< Foam::scalarField > ShermanMorrisonRank1Update ( const PtrList< scalarField > &  r1Updates, const scalarField &  p, const tmp< scalarField > &  diag, const scalarField &  mult, label  n  )

protected

Recursive (naive) implementation of the rank-1 update.

WIP, efficient for up to 2 flow-related constraints

Definition at line 455 of file ISQP.C.

References Foam::diag(), n, p, tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

lineSearch()

Foam::scalar lineSearch ( )

protected

Perform line search and return max residual corresponding to the updated solution.

Definition at line 538 of file ISQP.C.

References Foam::ensightOutput::debug, DebugInfo, Foam::endl(), Foam::gMax(), Foam::Info, Foam::mag(), Foam::magSqr(), Foam::min(), n, Foam::nl, Foam::reduce(), Foam::sqrt(), and Foam::tab.

Here is the call graph for this function:

adjustStep()

void adjustStep ( scalar &  step, const scalar  value, const scalar  update  )

protected

Adjust step to satisfy cireteria.

Definition at line 630 of file ISQP.C.

References update().

Here is the call graph for this function:

updateSolution()

void updateSolution ( const scalar  step )

protected

Update the current solution using the known direction and the given step length.

Definition at line 643 of file ISQP.C.

computeResiduals()

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

protected

Compute and return residuals based on the current solution.

Definition at line 663 of file ISQP.C.

References Foam::identity(), n, tmp< T >::ref(), Field< Type >::rmap(), and Foam::Zero.

Here is the call graph for this function:

resFL()

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

protected

Residual of the gradient of the Lagrangian.

Size is that of the active design variables

Definition at line 723 of file ISQP.C.

References Foam::ensightOutput::debug, Foam::endl(), forAll, Foam::gSum(), Foam::Info, Foam::mag(), and tmp< T >::ref().

Here is the call graph for this function:

invHFL()

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

protected

Product of the inverse Hessian with the residual of the gradient of the Lagrangian.

Avoid the formation of the Hessian matrix. Size is that of the active design variables.

Definition at line 755 of file ISQP.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

resFGs()

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

protected

Residual of the inequality constraint slackness.

Definition at line 780 of file ISQP.C.

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

Here is the call graph for this function:

resFlamda()

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

protected

Residual of the complementarity slackness for the inequality constraints.

Definition at line 806 of file ISQP.C.

resFls()

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

protected

Residual of the lower bounds slackness.

Definition at line 812 of file ISQP.C.

References x, and xMin.

resFus()

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

protected

Residual of the upper bounds slackness.

Definition at line 826 of file ISQP.C.

References x, and xMax.

resFlTilda()

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

protected

Residual of the complementarity slackness for the lower bound constraints.

Definition at line 840 of file ISQP.C.

resFuTilda()

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

protected

Residual of the complementarity slackness for the upper bound constraints.

Definition at line 850 of file ISQP.C.

resFExtraVars()

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

protected

Residual of the Lagrangian derivative wrt the extra variables.

Definition at line 860 of file ISQP.C.

resFz()

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

protected

Residual of the complementarity slackness for the extra variables.

Definition at line 870 of file ISQP.C.

storeOldFields()

void storeOldFields ( )

protected

Store old fields needed for the next iter.

Definition at line 966 of file ISQP.C.

References forAll.

meritFunctionConstraintPart()

Foam::scalar meritFunctionConstraintPart ( ) const

protectedvirtual

Get the part the merit function that depends on the constraints.

Implements SQPBase.

Definition at line 981 of file ISQP.C.

References Foam::pos(), and Foam::sum().

Here is the call graph for this function:

TypeName()

TypeName

(

"ISQP"

)

Runtime type information.

computeCorrection()

void computeCorrection ( )

virtual

Compute design variables correction.

Implements updateMethod.

Definition at line 1077 of file ISQP.C.

computeMeritFunction()

Foam::scalar computeMeritFunction ( )

virtual

Compute merit function. Could be different than the objective in the presence of constraints.

Reimplemented from updateMethod.

Definition at line 1103 of file ISQP.C.

References L(), Foam::max(), Foam::pos(), and Foam::sum().

Here is the call graph for this function:

meritFunctionDirectionalDerivative()

Foam::scalar meritFunctionDirectionalDerivative ( )

virtual

Derivative of the merit function. Could be different than the objective derivative in the presence of constraints.

Reimplemented from updateMethod.

Definition at line 1112 of file ISQP.C.

References Foam::pos(), and Foam::sum().

Here is the call graph for this function:

updateOldCorrection()

void updateOldCorrection ( const scalarField &  oldCorrection )

virtual

Update old correction. Useful for quasi-Newton methods coupled with line search.

Reimplemented from quasiNewton.

Definition at line 1122 of file ISQP.C.

References updateMethod::updateOldCorrection().

Here is the call graph for this function:

writeData()

bool writeData ( Ostream &  os ) const

virtual

Write useful quantities to files.

Reimplemented from LBFGS.

Definition at line 1129 of file ISQP.C.

References SQPBase::addToFile(), os(), and LBFGS::writeData().

Here is the call graph for this function:

writeAuxiliaryData()

bool writeAuxiliaryData ( )

virtual

Write merit function information.

Reimplemented from updateMethod.

Definition at line 1141 of file ISQP.C.

References SQPBase::writeMeritFunction().

Here is the call graph for this function:

Member Data Documentation

preconditionerNames

const Foam::Enum< Foam::ISQP::preconditioners > preconditionerNames

static

Names of preconditioners for the subproblem.

Definition at line 83 of file ISQP.H.

doAllocateLagrangeMultipliers_

bool doAllocateLagrangeMultipliers_

protected

Should Lagrange multipliers be allocated.

Definition at line 93 of file ISQP.H.

includeBoundConstraints_

bool includeBoundConstraints_

protected

Are bound constraints included?

Definition at line 98 of file ISQP.H.

Referenced by ISQP::updateSizes().

includeExtraVars_

bool includeExtraVars_

protected

Are additional design variables included?

These are introduced to find relaxed solutions, even if the original problem does not have any feasible points

Definition at line 106 of file ISQP.H.

p_

scalarField p_

protected

The set of design variables being updated during the subproblem.

Size is that of the active design variables. Correction will end up being the difference of this and the old design variables.

Definition at line 115 of file ISQP.H.

Referenced by ISQP::updateSizes().

gs_

scalarField gs_

protected

Slack variables for the inequality constraints.

Definition at line 122 of file ISQP.H.

lTilda_

autoPtr<scalarField> lTilda_

protected

Lagrange multipliers for the lower bound constraints.

Definition at line 127 of file ISQP.H.

Referenced by ISQP::updateSizes().

ls_

autoPtr<scalarField> ls_

protected

Slack variables the lower bound constraints.

Definition at line 132 of file ISQP.H.

Referenced by ISQP::updateSizes().

uTilda_

autoPtr<scalarField> uTilda_

protected

Lagrange multipliers for the upper bound constraints.

Definition at line 137 of file ISQP.H.

Referenced by ISQP::updateSizes().

us_

autoPtr<scalarField> us_

protected

Slack variables the upper bound constraints.

Definition at line 142 of file ISQP.H.

Referenced by ISQP::updateSizes().

extraVars_

autoPtr<scalarField> extraVars_

protected

Extra variables for finding solutions even in infeasible problems.

Definition at line 148 of file ISQP.H.

z_

autoPtr<scalarField> z_

protected

Lagrange multipliers for positive extra variables.

Definition at line 153 of file ISQP.H.

c_

scalar c_

protected

Multiplier of the additional variables y in the Lagrangian, to make them 'expensive'.

Definition at line 159 of file ISQP.H.

deltaP_

scalarField deltaP_

protected

Definition at line 164 of file ISQP.H.

Referenced by ISQP::updateSizes().

deltaLamda_

scalarField deltaLamda_

protected

Definition at line 165 of file ISQP.H.

deltaGs_

scalarField deltaGs_

protected

Definition at line 166 of file ISQP.H.

deltaLTilda_

autoPtr<scalarField> deltaLTilda_

protected

Definition at line 167 of file ISQP.H.

Referenced by ISQP::updateSizes().

deltaLs_

autoPtr<scalarField> deltaLs_

protected

Definition at line 168 of file ISQP.H.

Referenced by ISQP::updateSizes().

deltaUTilda_

autoPtr<scalarField> deltaUTilda_

protected

Definition at line 169 of file ISQP.H.

Referenced by ISQP::updateSizes().

deltaUs_

autoPtr<scalarField> deltaUs_

protected

Definition at line 170 of file ISQP.H.

Referenced by ISQP::updateSizes().

deltaExtraVars_

autoPtr<scalarField> deltaExtraVars_

protected

Definition at line 171 of file ISQP.H.

deltaZ_

autoPtr<scalarField> deltaZ_

protected

Definition at line 172 of file ISQP.H.

eps_

scalar eps_

protected

Infinitesimal quantity.

Updated during the inner iterations of the subproblem

Definition at line 180 of file ISQP.H.

epsMin_

scalar epsMin_

protected

Final eps quantity to be reached during the solution of the subproblem.

Definition at line 186 of file ISQP.H.

maxNewtonIters_

label maxNewtonIters_

protected

Maxmimum number of Newton iterations for the subproblem.

Definition at line 191 of file ISQP.H.

maxLineSearchIters_

label maxLineSearchIters_

protected

Maxmimum number of line search iterations for each iteration of the subproblem.

Definition at line 197 of file ISQP.H.

maxDxIters_

label maxDxIters_

protected

Maxmimum number of iterations for the deltaX equation.

Definition at line 202 of file ISQP.H.

relTol_

scalar relTol_

protected

Relative tolerance of the CG solver, solving for deltaP_.

Definition at line 207 of file ISQP.H.

preconType_

label preconType_

protected

Which preconditioner to use for the solution of the subproblem.

Definition at line 212 of file ISQP.H.

cRed_

scalar cRed_

protected

Percentage reduction for the constraints.

Can be used to relax QP problems with no feasible points

Definition at line 219 of file ISQP.H.

meritFunctionFile_

autoPtr<OFstream> meritFunctionFile_

protected

File including the l1 merit function.

Definition at line 224 of file ISQP.H.

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/updateMethod/ISQP/ISQP.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/updateMethod/ISQP/ISQP.C