Update design variables using the Method of Moving Assymptotes. Can handle inequality constraints.
More...
|
| TypeName ("MMA") |
| Runtime type information. More...
|
|
| MMA (const fvMesh &mesh, const dictionary &dict, autoPtr< designVariables > &designVars, const label nConstraints, const word &type) |
| Construct from components. More...
|
|
virtual | ~MMA ()=default |
| Destructor. More...
|
|
void | computeCorrection () |
| Compute design variables correction. More...
|
|
void | solveSubproblem () |
| Solve subproblem using a Newton optimiser. More...
|
|
void | updateValuesAndApproximations () |
| Compute objective/constraint values and their approximations. More...
|
|
const PtrList< scalarField > & | getValuesAndApproximations () const |
| Get objective/constraint values and their approximations. More...
|
|
void | updateRho () |
| Update rho value if needed. More...
|
|
const scalarField & | getRho () const |
| Get rho value if needed. More...
|
|
void | setVariableRho (bool varRho=true) |
| Set variable rho. More...
|
|
bool | converged () |
| Checks convergence of GCMMA. More...
|
|
virtual bool | writeData (Ostream &os) const |
| Write useful quantities to files. More...
|
|
| 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...
|
|
| 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 () |
|
virtual scalar | computeMeritFunction () |
| Compute merit function. Could be different than the objective in the presence of constraints. More...
|
|
virtual scalar | meritFunctionDirectionalDerivative () |
| Directional derivative of the merit function, in the direction of the correction. Could be different than the objective directional derivative in the presence of constraints. More...
|
|
bool & | initialEtaSet () |
| Return whether initial eta was set. More...
|
|
virtual void | updateOldCorrection (const scalarField &oldCorrection) |
| Update old correction. Useful for quasi-newton methods coupled with line search. More...
|
|
virtual bool | writeAuxiliaryData () |
| Write non-continuation data, usually under the optimisation folder. More...
|
|
| 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 |
| The object is not global. More...
|
|
virtual fileName | filePath () const |
| Return complete path + object name if the file exists in the case otherwise null. More...
|
|
| 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...
|
|
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 object from registry, and remove all file watches. 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...
|
|
| 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 ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, 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 ®istry) |
| 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 ®istry) 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 |
|
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...
|
|
| 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 it is a 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 it is a dictionary) otherwise return nullptr. More...
|
|
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. 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...
|
|
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. 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) |
|
| 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...
|
|
| 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...
|
|