dynamicTopODesignVariables Class Reference

Design variables for topology optimisation problems. Active design variables are added gradually, to help the optimiser from being trapped to a sub-optimal solution track in the first optimisation cycles. More...

#include <dynamicTopODesignVariables.H>

Inheritance diagram for dynamicTopODesignVariables:

Collaboration diagram for dynamicTopODesignVariables:

Public Member Functions
	TypeName ("dynamicTopO")
	Runtime type information.
	dynamicTopODesignVariables (fvMesh &mesh, const dictionary &dict)
	Construct from dictionary.
	dynamicTopODesignVariables (fvMesh &mesh, const dictionary &dict, const label size)
	Construct from dictionary and size.
virtual	~dynamicTopODesignVariables ()=default
	Destructor.
virtual void	evolveNumber ()
	Update the active design variables.
virtual bool	writeData (Ostream &) const
	The writeData function required by the regIOobject write operation.
Public Member Functions inherited from topODesignVariables
	TypeName ("topO")
	Runtime type information.
	topODesignVariables (fvMesh &mesh, const dictionary &dict)
	Construct from dictionary.
	topODesignVariables (fvMesh &mesh, const dictionary &dict, const label size)
	Construct from dictionary and size.
virtual	~topODesignVariables ()=default
	Destructor.
virtual const volScalarField &	beta () const
	Get the indicator field.
virtual const scalarField &	interpolationField (const word &interpolationFieldName="beta") const
	Return interpolant.
virtual void	interpolate (volScalarField &field, const topOInterpolationFunction &interpolationFunc, const FieldField< Field, scalar > &fluidValues, const scalarField &solidValues, const label fieldi, const word &interpolationFieldName="beta") const
	Interpolate between the given field and solid values.
virtual void	interpolationSensitivities (scalarField &sens, const topOInterpolationFunction &interpolationFunc, const FieldField< Field, scalar > &fluidValues, const scalarField &solidValues, const label fieldi, const word &designVariablesName, const word &interpolationFieldName="beta") const
	Post-processing sensitivities due to interpolations based on the indicator fields.
virtual void	nullifyInSolid (scalarField &field, const topOInterpolationFunction &interpolationFunc) const
	Nullify given field in the solid domain.
virtual void	nullifyInSolidSensitivities (scalarField &sens, const topOInterpolationFunction &interpolationFunc, const word &designVariablesName) const
	Nullify given field in the solid domain.
virtual tmp< scalarField >	penalty (const word &interpolationFieldName, const topOInterpolationFunction &interpolationFunc) const
	Return the Brinkman penalisation term.
virtual tmp< scalarField >	penaltySensitivities (const word &interpolationFieldName, const topOInterpolationFunction &interpolationFunc) const
	Return the penalty term derivative.
virtual void	update (scalarField &correction)
	Update design variables based on a given correction.
virtual scalar	computeEta (scalarField &correction)
	Compute eta if not set in the first step.
virtual bool	globalSum () const
	Whether to use global sum when computing matrix-vector products in update methods.
virtual tmp< scalarField >	assembleSensitivities (adjointSensitivity &sens)
	Assemble sensitivity derivatives, by combining the part related to the primal and adjoint solution with the part related to the design variables.
virtual void	setInitialValues ()
	Set initial values of the design variables.
virtual void	addFvOptions (const PtrList< primalSolver > &primalSolver, const PtrList< adjointSolverManager > &adjointSolverManagers)
	Automatically add fvOptions depending on the design variables to the primal and adjoint solvers.
fieldRegularisation &	getRegularisation ()
	Get access to the regularisation object.
virtual void	writeDesignVars ()
	Write porosity field to file.
Public Member Functions inherited from topOVariablesBase
	TypeName ("topOVariablesBase")
	Runtime type information.
	topOVariablesBase (fvMesh &mesh, const dictionary &dict)
	Construct from dictionary.
virtual	~topOVariablesBase ()=default
	Destructor.
const topOZones &	getTopOZones () const
	Get topOZones.
scalar	getBetaMax () const
	Get betaMax value.
const pointField &	surfacePoints () const
const faceList &	surfaceFaces () const
virtual void	sourceTerm (DimensionedField< scalar, volMesh > &field, const topOInterpolationFunction &interpolationFunc, const scalar betaMax, const word &interpolationFieldName="beta") const
	Populate source terms for the flow equations.
virtual void	sourceTermSensitivities (scalarField &sens, const topOInterpolationFunction &interpolationFunc, const scalar betaMax, const word &designVariablesName, const word &interpolationFieldName="beta") const
	Post-processing sensitivities due to interpolations based on the indicator fields.
void	writeFluidSolidInterface (const volScalarField &indicator, const scalar isoValue, labelList &changedFaces, List< wallPointData< label > > &changedFacesInfo)
	Write the fluid-solid interface to files.
Public Member Functions inherited from localIOdictionary
	localIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
	Construct given an IOobject and optional fallback dictionary content.
	localIOdictionary (const IOobject &io, const dictionary &dict)
	Construct given an IOobject and fallback dictionary content.
	localIOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
	Construct given an IOobject, wanted typeName and optional fallback dictionary content.
	localIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream.
virtual	~localIOdictionary ()=default
	Destructor.
virtual bool	global () const
	The object is not global.
virtual fileName	filePath () const
	Return complete path + object name if the file exists in the case otherwise null.
Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch).
	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct.
	baseIOdictionary (baseIOdictionary &&)=default
	Move construct.
virtual	~baseIOdictionary ()=default
	Destructor.
	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
	Construct given an IOobject and optional fallback dictionary content (ununsed).
	baseIOdictionary (const IOobject &io, const dictionary &dict)
	Construct given an IOobject and fallback dictionary content (ununsed).
	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed).
const word &	name () const
	Name function is needed to disambiguate those inherited from regIOobject and dictionary.
virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation.
void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries.
void	operator= (baseIOdictionary &&rhs)
	Move assignment of dictionary entries.
void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	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).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
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.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	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.
	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.
	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.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a void type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
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. A void type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
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.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.
Public Member Functions inherited from dictionary
	ClassName ("dictionary")
	dictionary ()
	Default construct, a top-level empty dictionary.
	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name.
	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.
	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.
	dictionary (Istream &is, bool keepHeader)
	Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header.
	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary.
	dictionary (const dictionary &dict)
	Copy construct top-level dictionary.
	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary.
	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary.
	dictionary (dictionary &&dict)
	Move construct top-level dictionary.
autoPtr< dictionary >	clone () const
	Construct and return clone.
virtual	~dictionary ()
	Destructor.
const fileName &	name () const noexcept
	The dictionary name.
fileName &	name () noexcept
	The dictionary name for modification (use with caution).
word	dictName () const
	The local dictionary name (final part of scoped name).
fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case.
bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary).
const dictionary &	parent () const noexcept
	Return the parent dictionary.
const dictionary &	topDict () const
	Return the top of the tree.
label	startLineNumber () const
	Return line number of first token in dictionary.
label	endLineNumber () const
	Return line number of last token in dictionary.
SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents.
tokenList	tokens () const
	Return the dictionary as a list of tokens.
const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword.
entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find an entry (non-const access) with the given keyword.
bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword.
const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword.
const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
ITstream *	findStream (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return an entry stream if present (and it is a stream) otherwise return nullptr.
const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary.
dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation.
dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation.
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.
const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary.
wordList	toc () const
	Return the table of contents.
wordList	sortedToc () const
	Return the sorted table of contents.
template<class Compare>
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator.
List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns.
bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$').
bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$').
entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry.
entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry.
entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry.
entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry.
entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry.
entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry.
entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry.
template<class T>
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry.
entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry.
entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry.
entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry.
entry *	set (const keyType &k, std::nullptr_t)
	Assign an empty primitive entry, overwriting any existing entry.
entry *	set (const keyType &k, const UList< token > &tokens)
	Assign a primitive entry from a list of tokens, overwriting any existing entry.
entry *	set (const keyType &k, List< token > &&tokens)
	Assign a primitive entry from a list of tokens, overwriting any existing entry.
template<class T>
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry.
bool	remove (const word &keyword)
	Remove an entry specified by keyword.
bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,.
bool	merge (const dictionary &dict)
	Merge entries from the given dictionary.
void	clear ()
	Clear the dictionary.
void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument.
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.
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.
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.
void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header.
void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header.
void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries.
void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting.
const_searcher	csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword.
const_searcher	search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search dictionary for given keyword.
searcher	search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Search dictionary for given keyword.
const_searcher	csearchScoped (const word &keyword, enum keyType::option matchOpt) const
	Search using scoping.
const_searcher	searchScoped (const word &keyword, enum keyType::option matchOpt) const
	Search using dot or slash scoping.
searcher	searchScoped (const word &keyword, enum keyType::option matchOpt)
	Search using dot or slash scoping.
const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping.
const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping.
dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping.
dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping.
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.
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.
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.
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.
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.
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.
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.
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.
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.
void	operator= (const dictionary &rhs)
	Copy assignment.
void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary.
void	operator|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary.
void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary.
bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<bool>(const word&, keyType::option).
label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<label>(const word&, keyType::option).
scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<scalar>(const word&, keyType::option).
string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<string>(const word&, keyType::option).
word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<word>(const word&, keyType::option).
fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get<fileName>(const word&, keyType::option).
bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check for existence of a sub-dictionary. Generally prefer findDict() for more flexibility.
template<class T>
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
	Same as getOrDefault().
template<class T>
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
	Same as getOrAdd().
ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) - use lookup() method.
bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10).
entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10).
const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10).
const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10).
const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10).
dictionary *	subDictPtr (const word &keyword)
	Deprecated(2018-10) Find and return a sub-dictionary pointer if present.
const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10).
ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10).
template<class T>
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10).
template<class T>
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10).
template<class T>
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10).
template<class T>
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T.
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< DLListBase, T >
	ILList ()=default
	Default construct.
	ILList (T *item)
	Construct and add initial item pointer.
	ILList (Istream &is)
	Construct from Istream.
	ILList (const ILList< DLListBase, T > &lst)
	Copy construct using the 'clone()' method for each element.
	ILList (ILList< DLListBase, T > &&lst)
	Move construct.
	ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'.
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	~ILList ()
	Destructor. Calls clear().
void	clear ()
	Clear the contents of the list.
void	pop_front (label n=1)
	Remove first element(s) from the list (deletes pointers).
bool	erase (T *item)
	Remove the specified element from the list and delete it.
void	transfer (ILList< DLListBase, T > &lst)
	Transfer the contents of the argument into this List and annul the argument list.
void	operator= (const ILList< DLListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element.
void	operator= (ILList< DLListBase, T > &&lst)
	Move assignment.
Public Member Functions inherited from UILList< DLListBase, T >
	UILList ()=default
	Default construct.
	UILList (T *item)
	Construct and add initial item pointer.
	UILList (const UILList< DLListBase, T > &list)
	Construct as copy.
T *	front ()
	The first entry in the list.
const T *	front () const
	The first entry in the list (const access).
T *	back ()
	The last entry in the list.
const T *	back () const
	The last entry in the list (const access).
T *	removeHead ()
	Remove and return head.
T *	remove (T *item)
	Remove and return element.
T *	remove (iterator &iter)
	Remove and return item specified by iterator.
void	operator= (const UILList< DLListBase, T > &lst)
	Copy assignment.
bool	operator== (const UILList< DLListBase, T > &lst) const
	Equality. True both lists are element-wise equal.
bool	operator!= (const UILList< DLListBase, T > &lst) const
	The opposite of the equality operation. Takes linear time.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write UILList with line-breaks when length exceeds shortLen.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
reverse_iterator	rbegin ()
	Iterator to last item in list with non-const access.
const_reverse_iterator	crbegin () const
	Iterator to last item in list with const access.
const_iterator	begin () const
	Iterator to first item in list with const access.
const_reverse_iterator	rbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for forward iterators.
const const_iterator &	cend () const
	End of list for forward iterators.
const reverse_iterator &	rend ()
	End of list for reverse iterators.
const const_reverse_iterator &	crend () const
	End of list for reverse iterators.
const const_iterator &	end () const
	End of list for forward iterators.
const const_reverse_iterator &	rend () const
	End of list for reverse iterators.
T *	first ()
	The first entry in the list.
const T *	first () const
	The first entry in the list (const access).
T *	last ()
	The last entry in the list.
const T *	last () const
	The last entry in the list (const access).
Public Member Functions inherited from DLListBase
	DLListBase ()=default
	Default construct.
	DLListBase (const DLListBase &)=delete
	No copy construct.
void	operator= (const DLListBase &)=delete
	No copy assignment.
	~DLListBase ()=default
	Destructor.
bool	empty () const noexcept
	True if the list is empty.
label	size () const noexcept
	The number of elements in list.
link *	front ()
	Return first entry.
const link *	front () const
	Return const access to first entry.
link *	back ()
	Return last entry.
const link *	back () const
	Return const access to last entry.
void	push_front (link *item)
	Add at front of list.
void	push_back (link *item)
	Add at back of list.
bool	swapUp (link *item)
	Swap this element with the one above unless it is at the top.
bool	swapDown (link *item)
	Swap this element with the one below unless it is at the bottom.
link *	removeHead ()
	Remove and return first entry.
link *	remove (link *item)
	Remove and return element.
link *	remove (iterator &iter)
	Remove and return element specified by iterator.
link *	replace (link *oldLink, link *newLink)
	Replace oldLink with newLink and return element.
link *	replace (iterator &oldIter, link *newitem)
	Replace oldIter with newItem and return element.
void	clear ()
	Clear the list.
void	swap (DLListBase &lst)
	Swap the contents of the list.
void	transfer (DLListBase &lst)
	Transfer the contents of the argument into this list and annul the argument list.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
const_iterator	crbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for iterators.
const const_iterator &	cend () const
	End of list for iterators.
const const_iterator &	crend () const
	End of list for reverse iterators.
link *	first ()
	Return first entry.
const link *	first () const
	Return const access to first entry.
link *	last ()
	Return last entry.
const link *	last () const
	Return const access to last entry.
void	prepend (link *item)
	Add at front of list.
void	append (link *item)
	Add at back of list.
Public Member Functions inherited from designVariables
	TypeName ("designVariables")
	Runtime type information.
	declareRunTimeNewSelectionTable (autoPtr, designVariables, designVariables,(fvMesh &mesh, const dictionary &dict),(mesh, dict))
	designVariables (fvMesh &mesh, const dictionary &dict)
	Construct from dictionary.
	designVariables (fvMesh &mesh, const dictionary &dict, const label size)
	Construct from dictionary and size.
virtual	~designVariables ()=default
	Destructor.
virtual bool	readDict (const dictionary &dict)
	Read dictionary if changed.
virtual const scalarField &	getVars () const
	Get the design variables.
virtual scalarField &	getVars ()
	Get the design variables.
virtual void	storeDesignVariables ()
	Store design variables, as the starting point for line search.
virtual void	resetDesignVariables ()
	Reset to the starting point of line search.
const labelList &	activeDesignVariables () const
	Return list of active design variables.
bool	isMaxInitChangeSet () const
	Check whether the max. initial change of the design variables has been set.
const autoPtr< scalar > &	getMaxInitChange ()
	Get maxInitChange.
void	setMaxInitChange (const scalar maxInitChange)
	Set maxInitChange.
virtual bool	resetEta () const
	Trigger the recomputation of eta by updateMethod.
const autoPtr< scalarField > &	lowerBounds () const
	Get min bounds for the design variables.
const autoPtr< scalarField > &	upperBounds () const
	Get max bounds for the design variables.
scalarField &	lowerBoundsRef ()
	Get min bounds for the design variables.
scalarField &	upperBoundsRef ()
	Get max bounds for the design variables.
virtual void	postProcessSens (scalarField &objectiveSens, PtrList< scalarField > &constraintSens, const wordList &adjointSolversNames, bool isMaster)
	Post process sensitivities if needed.
virtual tmp< scalarField >	constraintValues ()
	Design variables might add constraints related to themselves (e.g. linear combinations of the design variables) Return the values and gradients of these constraints.
virtual PtrList< scalarField >	constraintDerivatives ()
Public Member Functions inherited from Field< scalar >
constexpr	Field () noexcept
	Default construct.
	Field (const label len)
	Construct given size.
	Field (const label len, const scalar &val)
	Construct given size and initial value.
	Field (const label len, Foam::zero)
	Construct given size and initial values of zero.
	Field (Foam::one, const scalar &val)
	Construct with length=1, copying the value as the only content.
	Field (Foam::one, scalar &&val)
	Construct with length=1, moving the value as the only content.
	Field (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	Field (const Field< scalar > &fld)
	Copy construct.
	Field (const UList< scalar > &list)
	Copy construct from UList<Type>.
	Field (const IndirectListBase< scalar, Addr > &list)
	Copy construct from IndirectList.
	Field (Field< scalar > &&fld) noexcept
	Move construct from Field.
	Field (List< scalar > &&list) noexcept
	Move construct from List.
	Field (DynamicList< scalar, SizeMin > &&list)
	Move construct from DynamicList.
	Field (const UList< scalar > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field.
	Field (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field.
	Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field.
	Field (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field.
	Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field.
	Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items.
	Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied values for unmapped items.
	Field (Field< scalar > &fld, bool reuse)
	Copy construct or re-use as specified.
	Field (const tmp< Field< scalar > > &tfld)
	Copy or move construct from tmp.
	Field (Istream &is)
	Construct from Istream.
	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry.
	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign():
tmp< Field< scalar > >	clone () const
	Clone.
void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour:
bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above).
void	map (const UList< scalar > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field
void	map (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field
void	map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field.
void	map (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field.
void	map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field.
void	map (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field.
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self.
void	rmap (const UList< scalar > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field
void	rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field
void	rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field.
void	rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field.
void	negate ()
	Inplace negate this field (negative).
void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields.
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field.
void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field.
void	replace (const direction, const cmptType &)
	Replace a component field of the field.
void	clamp_min (const scalar &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_min (const UList< scalar > &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const scalar &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_max (const UList< scalar > &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const scalar &lower, const scalar &upper)
	Clamp field values (in-place) to the specified range.
void	clamp_range (const MinMax< scalar > &range)
	Clamp field values (in-place) to the specified range.
VSForm	block (const label start) const
tmp< Field< scalar > >	T () const
	Return the field transpose (only defined for second rank tensors).
void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry.
SubField< scalar >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking.
const SubField< scalar >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking.
SubField< scalar >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking.
const SubField< scalar >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking.
void	operator= (const Field< scalar > &)
	Copy assignment.
void	operator= (const tmp< Field< scalar > > &)
void	operator= (const UList< scalar > &rhs)
void	operator= (const SubField< scalar > &rhs)
void	operator= (const IndirectListBase< scalar, Addr > &rhs)
	Copy assign from IndirectList.
void	operator= (Field< scalar > &&rhs)
	Move assignment.
void	operator= (List< scalar > &&rhs)
void	operator= (DynamicList< scalar, SizeMin > &&rhs)
void	operator= (const scalar &val)
	Assign entries to the given value.
void	operator= (Foam::zero)
	Assign entries to zero.
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator+= (const UList< scalar > &)
void	operator+= (const tmp< Field< scalar > > &)
void	operator-= (const UList< scalar > &)
void	operator-= (const tmp< Field< scalar > > &)
void	operator*= (const UList< scalar > &)
void	operator*= (const tmp< Field< scalar > > &)
void	operator/= (const UList< scalar > &)
void	operator/= (const tmp< Field< scalar > > &)
void	operator+= (const scalar &)
void	operator-= (const scalar &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
	Field (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	operator= (const tmp< Field > &rhs)
void	normalise ()
void	normalise ()
void	normalise ()
	Inplace normalise (float) vector field.
void	normalise ()
	Inplace normalise (double) vector field.
Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from List< scalar >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const scalar &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const scalar &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, scalar &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< scalar > &list)
	Copy construct from list.
	List (const UList< scalar > &list)
	Copy construct contents from list.
	List (List< scalar > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< scalar > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< scalar > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< scalar, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< scalar > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< scalar, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< scalar > list)
	Construct from an initializer list.
	List (List< scalar > &&list) noexcept
	Move construct from List.
	List (DynamicList< scalar, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< scalar > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const scalar &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const scalar &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< scalar > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< scalar, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
scalar &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
scalar &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const scalar &val)
	Append an element at the end of the list.
void	push_back (scalar &&val)
	Move append an element at the end of the list.
void	push_back (const UList< scalar > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< scalar, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const scalar &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< scalar > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< scalar > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< scalar, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< scalar, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< scalar > list)
	Assignment to an initializer list.
void	operator= (const scalar &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< scalar > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< scalar, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< scalar > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const scalar &val)
	Append an element at the end of the list.
void	append (scalar &&val)
	Move append an element at the end of the list.
void	append (const UList< scalar > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< scalar, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const scalar &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const scalar &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< scalar >
	UList (const UList< scalar > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< scalar > &&) noexcept=default
	Move construct, shallow copy.
UList< scalar > &	operator= (const UList< scalar > &)=delete
	No copy assignment (default: shallow copy).
UList< scalar > &	operator= (UList< scalar > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (scalar *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< scalar > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const scalar &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
scalar &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const scalar &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
scalar &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const scalar *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
scalar *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
scalar &	front ()
	Access first element of the list, position [0].
const scalar &	front () const
	Access first element of the list.
scalar &	back ()
	Access last element of the list, position [size()-1].
const scalar &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const scalar &val) const
	True if the value is contained in the list.
bool	contains (const scalar &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const scalar &val) const
	Find index of the first occurrence of the value.
label	find (const scalar &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const scalar &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (scalar *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< scalar > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< scalar > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< scalar, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< scalar >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< scalar >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< scalar >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< scalar >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
scalar &	operator[] (const label i)
	Return element of UList.
const scalar &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< scalar > & () const
	Allow cast to a const List<T>&.
void	operator= (const scalar &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< scalar > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< scalar > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< scalar > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< scalar > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< scalar > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< scalar > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< scalar > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test bool value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return bool value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the bool entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
scalar &	first ()
	Access first element of the list, position [0].
const scalar &	first () const
	Access first element of the list.
scalar &	last ()
	Access last element of the list, position [size()-1].
const scalar &	last () const
	Access last element of the list, position [size()-1].
bool	found (const scalar &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< scalar > & () const
	Allow cast to a const List<T>&.

Static Public Member Functions
static autoPtr< dynamicTopODesignVariables >	New (fvMesh &mesh, const dictionary &dict)
	Construct and return the selected design variables.
Static Public Member Functions inherited from topODesignVariables
static autoPtr< topODesignVariables >	New (fvMesh &mesh, const dictionary &dict)
	Construct and return the selected design variables.
Static Public Member Functions inherited from localIOdictionary
static dictionary	readContents (const IOobject &io)
	Read and return contents, testing for "dictionary" type. The IOobject will not be registered.
static dictionary	readContents (const IOobject &io, const word &wantedType)
	Read and return contents, testing for expected type. The IOobject will not be registered.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.
Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries.
static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries.
static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream.
Static Public Member Functions inherited from designVariables
static autoPtr< designVariables >	New (fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected design variables.
Static Public Member Functions inherited from Field< scalar >
static const Field< scalar > &	null () noexcept
	Return a null Field (reference to a nullObject). Behaves like an empty Field.
static autoPtr< Field< scalar > >	New (Istream &is)
	Return a pointer to a new Field created on freestore.
static tmp< Field< scalar > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values.
Static Public Member Functions inherited from FieldBase
static void	warnLocalBoundaryConsistencyCompat (const dictionary &)
	Warn about keyword changes for local boundary consistency checks.
static int	localBoundaryConsistency () noexcept
	Get flag for local boundary consistency checks.
static int	localBoundaryConsistency (int val) noexcept
	Set flag for local boundary consistency checks.
Static Public Member Functions inherited from List< scalar >
static const List< scalar > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< scalar >
static const UList< scalar > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

Protected Member Functions
virtual void	setActiveDesignVariables (const label fluidID=0, const bool activeIO=false)
	Set active design variables.
Protected Member Functions inherited from topODesignVariables
virtual void	updateField (const scalarField &correction, const label fluidID=0)
	Update the design variables given their correction.
void	applyFixedValues ()
	Apply fixed values in certain zones.
void	readField (const word &name, const label fluidID=0, const bool setIOValues=false)
	Read field with (path of) the design variables and store input in the design variables list with optional offset.
virtual void	initialize ()
	Part of the constructor initialisation.
Protected Member Functions inherited from topOVariablesBase
void	setCutInterfaceFaces (const volScalarField &y, labelList &changedFaces, List< wallPointData< label > > &changedFacesInfo) const
	Based on the current pseudo-distance field y, identity the zero level-set iso-surface, write it to files for post-processing and set the seeds for the distance calculation from this iso-surface.
DynamicList< label >	faceFaces (const label facei) const
	Construct facesFaces for a given boundary face.
bool	addCutBoundaryFaceToIsoline (const label facei, const cutFaceIso &cutFace, DynamicList< vector > &isoSurfPts, DynamicList< face > &isoSurfFaces, DynamicList< label > &zoneIDs, List< DynamicList< label > > &cuttingFacesPerMeshFace) const
	Check whether the cutFace intersects the boundary of the initial domain and add fluid part of the intersected face to the isoline.
bool	isDuplicatePoint (const label pointID, const vector &pointi, const DynamicList< label > &cuttingFaces, const DynamicList< point > &isoSurfPts, const DynamicList< face > &isoSurfFaces, labelList &uniquePointIDs) const
bool	addCuttingFaceToIsoline (const DynamicList< point > &facePoints, const label nSerialPatches, const DynamicList< label > &cellCutFaces, const List< DynamicList< label > > &cuttingFacesPerMeshFace, DynamicList< vector > &isoSurfPts, DynamicList< face > &isoSurfFaces, DynamicList< label > &zoneIDs) const
	Add the cutting face to the zero level-set iso-surface.
void	addBoundaryFacesToIsoline (const pointScalarField &pointY, const Map< label > &addedFaces, const scalar isoValue, DynamicList< vector > &isoSurfPts, DynamicList< face > &isoSurfFaces, DynamicList< label > &zoneIDs, label &nChangedFaces, labelList &changedFaces, List< wallPointData< label > > &changedFacesInfo, labelList &changedFaceToCutFace, List< DynamicList< label > > &cuttingFacesPerMeshFace)
	Check whether the boundary faces of the initial domain belong to the fluid part and add them to the surface describing the fluid domain.
void	writeSurfaceFiles (const pointField &pts, const faceList &faces, const labelList &zoneIds, const label nSerialPatches) const
	Write the surface describing the fluid domain to stl and vtp files.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.
Protected Member Functions inherited from DLListBase
template<class IteratorType>
IteratorType	iterator_first () const
	Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType	iterator_last () const
	Return iterator to last item or end-iterator if list is empty.
Protected Member Functions inherited from designVariables
void	readBounds (autoPtr< scalar > lowerBoundPtr=nullptr, autoPtr< scalar > upperBoundPtr=nullptr)
	Read bounds for design variables, if present.
Protected Member Functions inherited from UList< scalar >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const scalar &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Protected Attributes
marchingCells	marchCells_
	Mechanism for gradually activating design variables.
label	evolvedCount_
	Number of times the design variables have evolved.
Protected Attributes inherited from topODesignVariables
SubField< scalar >	alpha_
	A subfield of the design variables corresponding to the porosity field.
fieldRegularisation	regularisation_
	Mechanism to regularise the field of design variables.
bool	writeAllFields_
	Write all fields related to imposition of the Brinkman penalisation (i.e. design variables, regularised design variables and the indicator field).
bool	addFvOptions_
	Add the fvOptions necessary for topO automatically.
Protected Attributes inherited from topOVariablesBase
topOZones	zones_
	Cell zones useful for defining the constant and changing parts of the domain in topO.
fileName	isoSurfFolder_
	Folder name holding the zero level-set iso-surface.
Map< label >	meshFaceToChangedFace_
	Map between iso-surface and mesh faces (internal and boundary).
pointField	surfPoints_
	Per cutting face, the changed faces owned by it.
faceList	surfFaces_
	Iso-surface faces.
Protected Attributes inherited from designVariables
fvMesh &	mesh_
dictionary	dict_
labelList	activeDesignVariables_
	Which of the design variables will be updated.
autoPtr< scalarField >	oldDesignVariables_
	Copy of old design variables. Useful when performing line-search.
autoPtr< scalar >	maxInitChange_
	Maximum design variables' change in the first optimisation cycle.
autoPtr< scalarField >	lowerBounds_
	Lower bounds of the design variables.
autoPtr< scalarField >	upperBounds_
	Upper bounds of the design variables.

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access.
typedef Searcher< false >	searcher
	Searcher with non-const access.
Public Types inherited from UILList< DLListBase, T >
typedef T	value_type
	Type of values stored.
typedef T *	pointer
	Pointer for value_type.
typedef const T *	const_pointer
	Const pointer for value_type.
typedef T &	reference
	Reference for value_type.
typedef const T &	const_reference
	Const reference for value_type.
typedef label	size_type
	The type that can represent the container size.
typedef label	difference_type
	The difference between iterator objects.
using	base_iterator
using	const_base_iterator
Public Types inherited from Field< scalar >
typedef pTraits< scalar >::cmptType	cmptType
	Component type.
typedef SubField< scalar >	subField
	Declare type of subField.
Public Types inherited from List< scalar >
typedef SubList< scalar >	subList
	Declare type of subList.
Public Types inherited from UList< scalar >
typedef scalar	value_type
	The value type the list contains.
typedef scalar *	pointer
	The pointer type for non-const access to value_type items.
typedef const scalar *	const_pointer
	The pointer type for const access to value_type items.
typedef scalar &	reference
	The type used for storing into value_type objects.
typedef const scalar &	const_reference
	The type used for reading from constant value_type objects.
typedef scalar *	iterator
	Random access iterator for traversing a UList.
typedef const scalar *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.
Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes.
friend	searcher
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary.
static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries.
static refPtr< OSstream >	reportingOutput
	Output location when reporting default values.
Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field.
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size.
static bool	unifiedGeometricField
	GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int	localBoundaryConsistency_
	Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar	localBoundaryTolerance_
	Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".
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.
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.
Static Protected Member Functions inherited from DLListBase
template<class IteratorType>
static const IteratorType &	iterator_end ()
	Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType &	iterator_rend ()
	Factory method to return an iterator reverse end.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

Design variables for topology optimisation problems. Active design variables are added gradually, to help the optimiser from being trapped to a sub-optimal solution track in the first optimisation cycles.

Source files

• dynamicTopODesignVariables.H
• dynamicTopODesignVariables.C

Definition at line 52 of file dynamicTopODesignVariables.H.

Constructor & Destructor Documentation

dynamicTopODesignVariables() [1/2]

dynamicTopODesignVariables	(	fvMesh &	mesh,
		const dictionary &	dict )

Construct from dictionary.

Definition at line 67 of file dynamicTopODesignVariables.C.

References dict, and mesh.

dynamicTopODesignVariables() [2/2]

dynamicTopODesignVariables	(	fvMesh &	mesh,
		const dictionary &	dict,
		const label	size )

Construct from dictionary and size.

Definition at line 77 of file dynamicTopODesignVariables.C.

References dict, evolvedCount_, dictionary::getOrDefault(), marchCells_, mesh, UList< scalar >::size(), and dictionary::subDict().

Here is the call graph for this function:

~dynamicTopODesignVariables()

virtual ~dynamicTopODesignVariables ( )

virtualdefault

Destructor.

Member Function Documentation

setActiveDesignVariables()

void setActiveDesignVariables ( const label fluidID = 0, const bool activeIO = false )

protectedvirtual

Set active design variables.

Reimplemented from topODesignVariables.

Definition at line 41 of file dynamicTopODesignVariables.C.

References designVariables::activeDesignVariables_, evolvedCount_, marchCells_, Foam::max(), designVariables::mesh_, and topOVariablesBase::zones_.

Here is the call graph for this function:

TypeName()

TypeName

(

"dynamicTopO"

)

Runtime type information.

References dict, mesh, and UList< scalar >::size().

Here is the call graph for this function:

New()

Foam::autoPtr< Foam::dynamicTopODesignVariables > New ( fvMesh & mesh, const dictionary & dict )

static

Construct and return the selected design variables.

Definition at line 93 of file dynamicTopODesignVariables.C.

References dict, mesh, and autoPtr< T >::New().

Here is the call graph for this function:

evolveNumber()

void evolveNumber ( )

virtual

Update the active design variables.

Reimplemented from designVariables.

Definition at line 105 of file dynamicTopODesignVariables.C.

References designVariables::activeDesignVariables_, evolvedCount_, and marchCells_.

writeData()

bool writeData ( Ostream & os ) const

virtual

The writeData function required by the regIOobject write operation.

Reimplemented from topODesignVariables.

Definition at line 113 of file dynamicTopODesignVariables.C.

References evolvedCount_, os(), and topODesignVariables::writeData().

Here is the call graph for this function:

Member Data Documentation

marchCells_

marchingCells marchCells_

protected

Mechanism for gradually activating design variables.

Definition at line 63 of file dynamicTopODesignVariables.H.

Referenced by dynamicTopODesignVariables(), evolveNumber(), and setActiveDesignVariables().

evolvedCount_

label evolvedCount_

protected

Number of times the design variables have evolved.

Definition at line 68 of file dynamicTopODesignVariables.H.

Referenced by dynamicTopODesignVariables(), evolveNumber(), setActiveDesignVariables(), and writeData().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/dynamicTopODesignVariables/dynamicTopODesignVariables.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/dynamicTopODesignVariables/dynamicTopODesignVariables.C