NURBS3DVolume morpher. Includes support functions for gradient computations Base class providing support for different coordinate systems. More...
#include <NURBS3DVolume.H>
Public Member Functions | |
| TypeName ("NURBS3DVolume") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, NURBS3DVolume, dictionary,(const dictionary &dict, const fvMesh &mesh, bool computeParamCoors),(dict, mesh, computeParamCoors)) | |
| NURBS3DVolume (const dictionary &dict, const fvMesh &mesh, bool computeParamCoors=true) | |
| Construct from dictionary. | |
| NURBS3DVolume (const NURBS3DVolume &) | |
| Construct as copy. | |
| virtual | ~NURBS3DVolume ()=default |
| Destructor. | |
| tmp< vectorField > | computeParametricCoordinates (const vectorField &points) const |
| Compute parametric coordinates for a given set of points. | |
| vector | volumeDerivativeU (const scalar u, const scalar v, const scalar w) const |
| Volume point derivative wrt u at point u,v,w. | |
| vector | volumeDerivativeV (const scalar u, const scalar v, const scalar w) const |
| Volume point derivative wrt v at point u,v,w. | |
| vector | volumeDerivativeW (const scalar u, const scalar v, const scalar w) const |
| Volume point derivative wrt w at point u,v,w. | |
| tensor | JacobianUVW (const vector &u) const |
| Jacobian matrix wrt to the volume parametric coordinates. | |
| scalar | volumeDerivativeCP (const vector &u, const label cpI) const |
| Volume point derivative wrt to control point cpI at point u,v,w. | |
| vectorField | computeControlPointSensitivities (const pointVectorField &pointSens, const labelList &sensitivityPatchIDs) |
| Control point sensitivities computed using point-based surface sensitivities. | |
| vectorField | computeControlPointSensitivities (const volVectorField &faceSens, const labelList &sensitivityPatchIDs) |
| Control point sensitivities computed using face-based surface sensitivities. | |
| vectorField | computeControlPointSensitivities (const boundaryVectorField &faceSens, const labelList &sensitivityPatchIDs) |
| Control point sensitivities computed using face-based surface sensitivities. | |
| vector | computeControlPointSensitivities (const vectorField &faceSens, const label patchI, const label cpI) |
| Control point sensitivities computed using face-based surface sensitivities. | |
| tmp< tensorField > | dndbBasedSensitivities (const label patchI, const label cpI, bool DimensionedNormalSens=true) |
| Part of control point sensitivities related to the face normal variations. | |
| tmp< tensorField > | patchDxDb (const label patchI, const label cpI) |
| Get patch dx/db. | |
| tmp< tensorField > | patchDxDbFace (const label patchI, const label cpI) |
| Get patch dx/db. | |
| tmp< vectorField > | coordinates (const vectorField &uVector) const |
| Compute cartesian coordinates based on control points and parametric coordinates. | |
| vector | coordinates (const vector &uVector) const |
| The same, for a specific point. | |
| tmp< vectorField > | computeNewPoints (const vectorField &controlPointsMovement) |
| Mesh movement based on given control point movement. | |
| tmp< vectorField > | computeNewBoundaryPoints (const vectorField &controlPointsMovement, const labelList &patchesToBeMoved, const bool moveCPs=true) |
| Boundary mesh movement based on given control point movement. | |
| label | getCPID (const label i, const label j, const label k) const |
| Get control point ID from its I-J-K coordinates. | |
| void | getIJK (label &i, label &j, label &k, const label cpID) const |
| Get I-J-K coordinates from control point ID. | |
| void | setControlPoints (const vectorField &newCps) |
| Set new control points. | |
| void | boundControlPointMovement (vectorField &controlPointsMovement) const |
| Bound control points movement in the boundary control points and in certain directions if needed. | |
| scalar | computeMaxBoundaryDisplacement (const vectorField &controlPointsMovement, const labelList &patchesToBeMoved) |
| Compute max. displacement at the boundary. | |
| tmp< vectorField > | getPointsInBox () |
| Get mesh points that reside within the control points box. | |
| const labelList & | getMap () |
| Get map of points in box to mesh points. | |
| const labelList & | getReverseMap () |
| Get map of mesh points to points in box. Return -1 if point is outside the box. | |
| const pointVectorField & | getParametricCoordinates () |
| Get parametric coordinates. | |
| tmp< pointTensorField > | getDxDb (const label cpI) |
| Get dxCartesiandb for a certain control point. | |
| tmp< volTensorField > | getDxCellsDb (const label cpI) |
| Get dxCartesiandb for a certain control point on cells. | |
| label | nUSymmetry () const |
| Get number of variables if CPs are moved symmetrically in U. | |
| label | nVSymmetry () const |
| Get number of variables if CPs are moved symmetrically in V. | |
| label | nWSymmetry () const |
| Get number of variables if CPs are moved symmetrically in W. | |
| Vector< label > | nSymmetry () const |
| Get number of variables per direction, if CPs are moved symmetrically. | |
| const word & | name () const |
| Get box name. | |
| const boolList & | getActiveCPs () const |
| Which control points are active? | |
| const boolList & | getActiveDesignVariables () const |
| Which design variables are active? | |
| const vectorField & | getControlPoints () const |
| Get control points. | |
| vectorField & | getControlPoints () |
| bool | confineUMovement () const |
| Get confine movements. | |
| bool | confineVMovement () const |
| bool | confineWMovement () const |
| const NURBSbasis & | basisU () const |
| Get basis functions. | |
| const NURBSbasis & | basisV () const |
| const NURBSbasis & | basisW () const |
| Vector< label > | nCPsPerDirection () const |
| Get number of control points per direction. | |
| const fvMesh & | mesh () const |
| Get mesh. | |
| const dictionary & | dict () const |
| Get dictionary. | |
| void | writeCps (const fileName &="cpsFile", const bool transform=true) const |
| Write control points on a cartesian coordinates system for visualization. | |
| void | writeParamCoordinates () const |
| Write parametric coordinates. | |
| virtual bool | writeData (Ostream &os) const |
| Write the control points to support restart. | |
| 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 ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| 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. | |
| 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. | |
| 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. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| 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 ®istry) 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. | |
Static Public Member Functions | |
| static autoPtr< NURBS3DVolume > | New (const dictionary &dict, const fvMesh &mesh, bool computeParamCoors=true) |
| Return a reference to the selected NURBS model. | |
| 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. | |
Protected Types | |
| typedef List< boolVector > | boolVectorList |
Protected Member Functions | |
| void | findPointsInBox (const vectorField &meshPoints) |
| Find points within control points box. | |
| void | computeParametricCoordinates (const vectorField &points) |
| Compute parametric coordinates in order to match a given set of coordinates, based on the cps of the class. | |
| void | computeParametricCoordinates (tmp< vectorField > tPoints) |
| bool | bound (vector &vec, scalar minValue=1e-7, scalar maxValue=0.999999) const |
| Bound components to certain limits. | |
| void | determineActiveDesignVariablesAndPoints () |
| Create lists with active design variables and control points. | |
| void | confineBoundaryControlPoints () |
| Confine movement in boundary control points if necessary. | |
| void | continuityRealatedConfinement () |
| Confine control point movement to maintain user-defined continuity. | |
| void | confineControlPointsDirections () |
| Confine movement in all control points for user-defined directions. | |
| void | confineInertControlPoints () |
| Deactivate control points if they affect no mesh point. | |
| void | confineControlPoint (const label cpI) |
| Confine all three movements for a prescribed control point. | |
| void | confineControlPoint (const label cpI, const boolVector &) |
| Confine specific movements for a prescribed control point. | |
| void | makeFolders () |
| Create folders to store cps and derivatives. | |
| virtual vector | transformPointToCartesian (const vector &localCoordinates) const =0 |
| Transform a point from its coordinate system to a cartesian system. | |
| virtual tensor | transformationTensorDxDb (label globalPointIndex)=0 |
| Transformation tensor for dxdb, from local coordinate system to cartesian. | |
| virtual void | updateLocalCoordinateSystem (const vectorField &cartesianPoints)=0 |
| Update coordinates in the local system based on the cartesian points. | |
| 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 Attributes | |
| const fvMesh & | mesh_ |
| dictionary | dict_ |
| word | name_ |
| NURBSbasis | basisU_ |
| NURBS basis functions. | |
| NURBSbasis | basisV_ |
| NURBSbasis | basisW_ |
| label | maxIter_ |
| Max iterations for Newton-Raphson. | |
| scalar | tolerance_ |
| Tolerance for Newton-Raphson. | |
| label | nMaxBound_ |
| How many times to bound parametric coordinates until deciding it is outside the box. | |
| vectorField | cps_ |
| The volumetric B-Splines control points. | |
| autoPtr< labelList > | mapPtr_ |
| Map of points-in-box to mesh points. | |
| autoPtr< labelList > | reverseMapPtr_ |
| Map of mesh points to points-in-box. | |
| autoPtr< pointVectorField > | parametricCoordinatesPtr_ |
| Parametric coordinates of pointsInBox. | |
| vectorField | localSystemCoordinates_ |
| Coordinates in the local system for which CPs are defined. | |
| label | confineUMovement_ |
| Confine movement in certain directions and control points. Refers to the local system. | |
| label | confineVMovement_ |
| label | confineWMovement_ |
| label | confineBoundaryControlPoints_ |
| boolVectorList | confineUMinCPs_ |
| Which movement components to freeze in each plane. | |
| boolVectorList | confineUMaxCPs_ |
| boolVectorList | confineVMinCPs_ |
| boolVectorList | confineVMaxCPs_ |
| boolVectorList | confineWMinCPs_ |
| boolVectorList | confineWMaxCPs_ |
| boolList | activeControlPoints_ |
| Which of the cps are moved in an optimisation. | |
| boolList | activeDesignVariables_ |
| Which design variables are changed in an optimisation. | |
| string | cpsFolder_ |
| Folder to store control points. | |
| bool | readStoredData_ |
| Read parametric coordinates from file if present in the folder. | |
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 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 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. | |
NURBS3DVolume morpher. Includes support functions for gradient computations Base class providing support for different coordinate systems.
Reference:
For a short introduction to a volumetric B-Splines morpher and its use
in shape optimisation
Papoutsis-Kiachagias, E., Magoulas, N., Mueller, J.,
Othmer, C., & Giannakoglou, K. (2015).
Noise reduction in car aerodynamics using a surrogate objective
function and the continuous adjoint method with wall functions.
Computers & Fluids, 122, 223-232.
http://doi.org/10.1016/j.compfluid.2015.09.002
Definition at line 69 of file NURBS3DVolume.H.
|
protected |
Definition at line 77 of file NURBS3DVolume.H.
| NURBS3DVolume | ( | const dictionary & | dict, |
| const fvMesh & | mesh, | ||
| bool | computeParamCoors = true ) |
Construct from dictionary.
Definition at line 684 of file NURBS3DVolume.C.
References IOobjectOption::AUTO_WRITE, basisU_, basisV_, basisW_, confineUMovement_, cps_, dict(), dict_, dictionary::dictName(), dictionary::get(), dictionary::getOrDefault(), dictionary::getOrDefaultCompat(), localIOdictionary::localIOdictionary(), localSystemCoordinates_, mapPtr_, maxIter_, mesh(), mesh_, name_, nMaxBound_, nPoints, dictionary::null, parametricCoordinatesPtr_, IOobjectOption::READ_IF_PRESENT, reverseMapPtr_, IOobject::time(), timeName, tolerance_, and Foam::Zero.
Referenced by declareRunTimeSelectionTable(), NURBS3DVolume(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), and NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical().
| NURBS3DVolume | ( | const NURBS3DVolume & | ) |
Construct as copy.
References dict(), mesh(), and NURBS3DVolume().
|
virtualdefault |
Destructor.
References k, os(), points, and Foam::transform().
|
protected |
Find points within control points box.
Definition at line 43 of file NURBS3DVolume.C.
References cps_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, mapPtr_, Foam::max(), Foam::min(), Foam::reduce(), reverseMapPtr_, List< T >::setSize(), UList< T >::size(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
Referenced by getMap(), getParametricCoordinates(), getPointsInBox(), and getReverseMap().
|
protected |
Compute parametric coordinates in order to match a given set of coordinates, based on the cps of the class.
Uses a Newton-Raphson loop. Argument is the points residing in the box
Definition at line 97 of file NURBS3DVolume.C.
References IOobjectOption::AUTO_WRITE, Foam::bound(), Foam::cmptMag(), VectorSpace< Form, Cmpt, Ncmpts >::component(), coordinates(), cps_, Foam::diff(), Foam::dimless, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::inv(), JacobianUVW(), localSystemCoordinates_, Foam::mag(), mapPtr_, Foam::max(), maxIter_, mesh_, Foam::min(), name_, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >::New(), nMaxBound_, IOobjectOption::NO_READ, parametricCoordinatesPtr_, points, readStoredData_, Foam::reduce(), tmp< T >::ref(), reverseMapPtr_, List< T >::setSize(), UList< T >::size(), tolerance_, IOobject::typeHeaderOk(), WarningInFunction, Foam::Zero, and VectorSpace< Form, Cmpt, Ncmpts >::zero.
Referenced by computeParametricCoordinates(), and getParametricCoordinates().
|
protected |
Definition at line 331 of file NURBS3DVolume.C.
References computeParametricCoordinates(), and points.
Bound components to certain limits.
Definition at line 341 of file NURBS3DVolume.C.
References maxValue, minValue, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
|
protected |
Create lists with active design variables and control points.
Definition at line 394 of file NURBS3DVolume.C.
References activeControlPoints_, activeDesignVariables_, confineBoundaryControlPoints(), confineControlPointsDirections(), confineInertControlPoints(), continuityRealatedConfinement(), cps_, and forAll.
Referenced by NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), and NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical().
|
protected |
Confine movement in boundary control points if necessary.
Definition at line 490 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW_, confineBoundaryControlPoints_, confineControlPoint(), and getCPID().
Referenced by determineActiveDesignVariablesAndPoints().
|
protected |
Confine control point movement to maintain user-defined continuity.
Definition at line 536 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW_, confineControlPoint(), confineUMaxCPs_, confineUMinCPs_, confineVMaxCPs_, confineVMinCPs_, confineWMaxCPs_, confineWMinCPs_, forAll, and getCPID().
Referenced by determineActiveDesignVariablesAndPoints().
|
protected |
Confine movement in all control points for user-defined directions.
Definition at line 631 of file NURBS3DVolume.C.
References activeDesignVariables_, confineUMovement_, confineVMovement_, confineWMovement_, and cps_.
Referenced by determineActiveDesignVariablesAndPoints().
|
protected |
Deactivate control points if they affect no mesh point.
Definition at line 429 of file NURBS3DVolume.C.
References activeControlPoints_, activeDesignVariables_, basisU_, basisV_, basisW_, Foam::endl(), forAll, getIJK(), getMap(), getParametricCoordinates(), Foam::Info, k, UPstream::reduceOr(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
Referenced by determineActiveDesignVariablesAndPoints().
|
protected |
Confine all three movements for a prescribed control point.
Definition at line 642 of file NURBS3DVolume.C.
References activeDesignVariables_, cps_, Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
Referenced by confineBoundaryControlPoints(), and continuityRealatedConfinement().
|
protected |
Confine specific movements for a prescribed control point.
Definition at line 660 of file NURBS3DVolume.C.
References activeDesignVariables_, cps_, Foam::exit(), Foam::FatalError, FatalErrorInFunction, boolVector::x(), boolVector::y(), and boolVector::z().
|
protected |
Create folders to store cps and derivatives.
Definition at line 385 of file NURBS3DVolume.C.
References cpsFolder_, UPstream::master(), mesh_, and Foam::mkDir().
|
protectedpure virtual |
Transform a point from its coordinate system to a cartesian system.
Implemented in NURBS3DVolumeCartesian, and NURBS3DVolumeCylindrical.
Referenced by computeMaxBoundaryDisplacement(), computeNewBoundaryPoints(), computeNewPoints(), and writeCps().
|
protectedpure virtual |
Transformation tensor for dxdb, from local coordinate system to cartesian.
Implemented in NURBS3DVolumeCartesian, and NURBS3DVolumeCylindrical.
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeControlPointSensitivities(), dndbBasedSensitivities(), getDxCellsDb(), getDxDb(), patchDxDb(), and patchDxDbFace().
|
protectedpure virtual |
Update coordinates in the local system based on the cartesian points.
Implemented in NURBS3DVolumeCartesian, and NURBS3DVolumeCylindrical.
Referenced by computeNewBoundaryPoints(), and computeNewPoints().
| TypeName | ( | "NURBS3DVolume" | ) |
Runtime type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| NURBS3DVolume | , | ||
| dictionary | , | ||
| (const dictionary &dict, const fvMesh &mesh, bool computeParamCoors) | , | ||
| (dict, mesh, computeParamCoors) | ) |
|
static |
Return a reference to the selected NURBS model.
Definition at line 830 of file NURBS3DVolume.C.
References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh().
Referenced by volBSplinesBase::volBSplinesBase().
| Foam::tmp< Foam::vectorField > computeParametricCoordinates | ( | const vectorField & | points | ) | const |
Compute parametric coordinates for a given set of points.
(not necessarily the mesh ones)
Definition at line 861 of file NURBS3DVolume.C.
References Foam::bound(), Foam::cmptMag(), VectorSpace< Form, Cmpt, Ncmpts >::component(), coordinates(), cps_, Foam::endl(), forAll, Foam::Info, Foam::inv(), JacobianUVW(), Foam::max(), maxIter_, Foam::min(), name_, tmp< T >::New(), nMaxBound_, points, Foam::reduce(), tmp< T >::ref(), tolerance_, WarningInFunction, and Foam::Zero.
| Foam::vector volumeDerivativeU | ( | const scalar | u, |
| const scalar | v, | ||
| const scalar | w ) const |
Volume point derivative wrt u at point u,v,w.
Definition at line 968 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW(), basisW_, cps_, getCPID(), and Foam::Zero.
Referenced by JacobianUVW().
| Foam::vector volumeDerivativeV | ( | const scalar | u, |
| const scalar | v, | ||
| const scalar | w ) const |
Volume point derivative wrt v at point u,v,w.
Definition at line 1005 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW(), basisW_, cps_, getCPID(), and Foam::Zero.
Referenced by JacobianUVW().
| Foam::vector volumeDerivativeW | ( | const scalar | u, |
| const scalar | v, | ||
| const scalar | w ) const |
Volume point derivative wrt w at point u,v,w.
Definition at line 1043 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW_, cps_, getCPID(), and Foam::Zero.
Referenced by JacobianUVW().
| Foam::tensor JacobianUVW | ( | const vector & | u | ) | const |
Jacobian matrix wrt to the volume parametric coordinates.
Definition at line 1081 of file NURBS3DVolume.C.
References volumeDerivativeU(), volumeDerivativeV(), volumeDerivativeW(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
Referenced by computeParametricCoordinates(), and computeParametricCoordinates().
| Foam::scalar volumeDerivativeCP | ( | const vector & | u, |
| const label | cpI ) const |
Volume point derivative wrt to control point cpI at point u,v,w.
Scalar since in the local system!
Definition at line 1100 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW_, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeControlPointSensitivities(), dndbBasedSensitivities(), getDxCellsDb(), getDxDb(), patchDxDb(), and patchDxDbFace().
| Foam::vectorField computeControlPointSensitivities | ( | const pointVectorField & | pointSens, |
| const labelList & | sensitivityPatchIDs ) |
Control point sensitivities computed using point-based surface sensitivities.
Definition at line 1133 of file NURBS3DVolume.C.
References cps_, forAll, getParametricCoordinates(), Pstream::listReduce(), mesh_, reverseMapPtr_, transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
Referenced by computeControlPointSensitivities().
| Foam::vectorField computeControlPointSensitivities | ( | const volVectorField & | faceSens, |
| const labelList & | sensitivityPatchIDs ) |
Control point sensitivities computed using face-based surface sensitivities.
Definition at line 1183 of file NURBS3DVolume.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and computeControlPointSensitivities().
| Foam::vectorField computeControlPointSensitivities | ( | const boundaryVectorField & | faceSens, |
| const labelList & | sensitivityPatchIDs ) |
Control point sensitivities computed using face-based surface sensitivities.
Definition at line 1198 of file NURBS3DVolume.C.
References cps_, forAll, getParametricCoordinates(), Pstream::listReduce(), deltaBoundary::makeFaceCentresAndAreas_d(), mesh_, face::points(), reverseMapPtr_, UList< T >::size(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
| Foam::vector computeControlPointSensitivities | ( | const vectorField & | faceSens, |
| const label | patchI, | ||
| const label | cpI ) |
Control point sensitivities computed using face-based surface sensitivities.
Definition at line 1268 of file NURBS3DVolume.C.
References forAll, getParametricCoordinates(), deltaBoundary::makeFaceCentresAndAreas_d(), mesh_, face::points(), Foam::reduce(), reverseMapPtr_, UList< T >::size(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
| Foam::tmp< Foam::tensorField > dndbBasedSensitivities | ( | const label | patchI, |
| const label | cpI, | ||
| bool | DimensionedNormalSens = true ) |
Part of control point sensitivities related to the face normal variations.
Definition at line 1328 of file NURBS3DVolume.C.
References forAll, getParametricCoordinates(), deltaBoundary::makeFaceCentresAndAreas_d(), mesh_, tmp< T >::New(), face::points(), reverseMapPtr_, UList< T >::size(), polyPatch::start(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
| Foam::tmp< Foam::tensorField > patchDxDb | ( | const label | patchI, |
| const label | cpI ) |
Get patch dx/db.
Definition at line 1398 of file NURBS3DVolume.C.
References forAll, getParametricCoordinates(), mesh_, tmp< T >::New(), reverseMapPtr_, transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
| Foam::tmp< Foam::tensorField > patchDxDbFace | ( | const label | patchI, |
| const label | cpI ) |
Get patch dx/db.
Definition at line 1437 of file NURBS3DVolume.C.
References forAll, getParametricCoordinates(), deltaBoundary::makeFaceCentresAndAreas_d(), mesh_, tmp< T >::New(), face::points(), reverseMapPtr_, UList< T >::size(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
Referenced by getDxCellsDb().
| Foam::tmp< Foam::vectorField > coordinates | ( | const vectorField & | uVector | ) | const |
Compute cartesian coordinates based on control points and parametric coordinates.
Definition at line 1495 of file NURBS3DVolume.C.
References coordinates(), forAll, mapPtr_, tmp< T >::New(), nPoints, points, and Foam::Zero.
Referenced by computeMaxBoundaryDisplacement(), and computeNewBoundaryPoints().
| Foam::vector coordinates | ( | const vector & | uVector | ) | const |
The same, for a specific point.
Definition at line 1514 of file NURBS3DVolume.C.
References basisU_, basisV_, basisW(), basisW_, cps_, getCPID(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), Vector< Cmpt >::z(), and Foam::Zero.
| Foam::tmp< Foam::vectorField > computeNewPoints | ( | const vectorField & | controlPointsMovement | ) |
Mesh movement based on given control point movement.
Definition at line 1553 of file NURBS3DVolume.C.
References coordinates(), cps_, DebugInfo, Foam::endl(), forAll, getParametricCoordinates(), Foam::gMax(), Foam::mag(), mapPtr_, mesh_, tmp< T >::New(), transformPointToCartesian(), updateLocalCoordinateSystem(), and writeCps().
| Foam::tmp< Foam::vectorField > computeNewBoundaryPoints | ( | const vectorField & | controlPointsMovement, |
| const labelList & | patchesToBeMoved, | ||
| const bool | moveCPs = true ) |
Boundary mesh movement based on given control point movement.
Definition at line 1590 of file NURBS3DVolume.C.
References coordinates(), cps_, DebugInfo, Foam::endl(), getParametricCoordinates(), Foam::gMax(), Foam::mag(), mesh_, tmp< T >::New(), reverseMapPtr_, transformPointToCartesian(), updateLocalCoordinateSystem(), and writeCps().
| Foam::label getCPID | ( | const label | i, |
| const label | j, | ||
| const label | k ) const |
Get control point ID from its I-J-K coordinates.
Definition at line 1656 of file NURBS3DVolume.C.
References basisU_, basisV_, and k.
Referenced by confineBoundaryControlPoints(), continuityRealatedConfinement(), coordinates(), noConstraint::updateBoundaryBounds(), noConstraint::updateInternalBounds(), volumeDerivativeU(), volumeDerivativeV(), and volumeDerivativeW().
| void getIJK | ( | label & | i, |
| label & | j, | ||
| label & | k, | ||
| const label | cpID ) const |
Get I-J-K coordinates from control point ID.
Definition at line 1670 of file NURBS3DVolume.C.
References basisU_, basisV_, and k.
Referenced by confineInertControlPoints().
| void setControlPoints | ( | const vectorField & | newCps | ) |
Set new control points.
New values should be on the coordinates system original CPs were defined
Definition at line 1687 of file NURBS3DVolume.C.
References cps_, Foam::exit(), Foam::FatalError, FatalErrorInFunction, and UList< T >::size().
| void boundControlPointMovement | ( | vectorField & | controlPointsMovement | ) | const |
Bound control points movement in the boundary control points and in certain directions if needed.
Definition at line 1700 of file NURBS3DVolume.C.
References activeDesignVariables_, forAll, and Foam::Zero.
| Foam::scalar computeMaxBoundaryDisplacement | ( | const vectorField & | controlPointsMovement, |
| const labelList & | patchesToBeMoved ) |
Compute max. displacement at the boundary.
Definition at line 1723 of file NURBS3DVolume.C.
References coordinates(), cps_, getParametricCoordinates(), Foam::mag(), Foam::max(), mesh_, Foam::reduce(), reverseMapPtr_, transformPointToCartesian(), and Foam::Zero.
| Foam::tmp< Foam::vectorField > getPointsInBox | ( | ) |
Get mesh points that reside within the control points box.
Definition at line 1773 of file NURBS3DVolume.C.
References findPointsInBox(), localSystemCoordinates_, and mapPtr_.
Referenced by getParametricCoordinates().
| const Foam::labelList & getMap | ( | ) |
Get map of points in box to mesh points.
Definition at line 1788 of file NURBS3DVolume.C.
References findPointsInBox(), localSystemCoordinates_, and mapPtr_.
Referenced by confineInertControlPoints().
| const Foam::labelList & getReverseMap | ( | ) |
Get map of mesh points to points in box. Return -1 if point is outside the box.
Definition at line 1799 of file NURBS3DVolume.C.
References findPointsInBox(), localSystemCoordinates_, and reverseMapPtr_.
| const Foam::pointVectorField & getParametricCoordinates | ( | ) |
Get parametric coordinates.
Definition at line 1810 of file NURBS3DVolume.C.
References computeParametricCoordinates(), findPointsInBox(), getPointsInBox(), localSystemCoordinates_, mapPtr_, and parametricCoordinatesPtr_.
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeControlPointSensitivities(), computeMaxBoundaryDisplacement(), computeNewBoundaryPoints(), computeNewPoints(), confineInertControlPoints(), dndbBasedSensitivities(), getDxCellsDb(), getDxDb(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical(), patchDxDb(), and patchDxDbFace().
| Foam::tmp< Foam::pointTensorField > getDxDb | ( | const label | cpI | ) |
Get dxCartesiandb for a certain control point.
Definition at line 1828 of file NURBS3DVolume.C.
References Foam::dimless, getParametricCoordinates(), mapPtr_, mesh_, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, tmp< T >::ref(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
Referenced by volumetricBSplinesDesignVariables::dCdb().
| Foam::tmp< Foam::volTensorField > getDxCellsDb | ( | const label | cpI | ) |
Get dxCartesiandb for a certain control point on cells.
Definition at line 1871 of file NURBS3DVolume.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), deltaBoundary::cellCenters_d(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimless, forAll, getParametricCoordinates(), Foam::isA(), mapPtr_, mesh_, GeometricField< tensor, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, patchDxDbFace(), transformationTensorDxDb(), volumeDerivativeCP(), and Foam::Zero.
| Foam::label nUSymmetry | ( | ) | const |
Get number of variables if CPs are moved symmetrically in U.
Definition at line 1931 of file NURBS3DVolume.C.
References basisU_.
Referenced by nSymmetry().
| Foam::label nVSymmetry | ( | ) | const |
Get number of variables if CPs are moved symmetrically in V.
Definition at line 1938 of file NURBS3DVolume.C.
References basisV_.
Referenced by nSymmetry().
| Foam::label nWSymmetry | ( | ) | const |
Get number of variables if CPs are moved symmetrically in W.
Definition at line 1945 of file NURBS3DVolume.C.
References basisW_.
Referenced by nSymmetry().
| Foam::Vector< Foam::label > nSymmetry | ( | ) | const |
Get number of variables per direction, if CPs are moved symmetrically.
Definition at line 1952 of file NURBS3DVolume.C.
References nUSymmetry(), nVSymmetry(), and nWSymmetry().
|
inline |
|
inline |
Which control points are active?
A control point is active if at least one component can move
Definition at line 32 of file NURBS3DVolumeI.H.
References activeControlPoints_.
|
inline |
Which design variables are active?
Numbering is (X1,Y1,Z1), (X2,Y2,Z2) ...
Definition at line 39 of file NURBS3DVolumeI.H.
References activeDesignVariables_.
|
inline |
Get control points.
Definition at line 45 of file NURBS3DVolumeI.H.
References cps_.
Referenced by noConstraint::updateBoundaryBounds(), and noConstraint::updateInternalBounds().
|
inline |
Definition at line 51 of file NURBS3DVolumeI.H.
References cps_.
|
inline |
Get confine movements.
Definition at line 57 of file NURBS3DVolumeI.H.
References confineUMovement_.
|
inline |
Definition at line 63 of file NURBS3DVolumeI.H.
References confineVMovement_.
|
inline |
Definition at line 69 of file NURBS3DVolumeI.H.
References confineWMovement_.
|
inline |
|
inline |
Definition at line 81 of file NURBS3DVolumeI.H.
References basisV_.
|
inline |
Definition at line 87 of file NURBS3DVolumeI.H.
References basisW_.
Referenced by coordinates(), volumeDerivativeU(), and volumeDerivativeV().
|
inline |
Get number of control points per direction.
Definition at line 94 of file NURBS3DVolumeI.H.
References basisU_, basisV_, and basisW_.
Referenced by noConstraint::updateBoundaryBounds(), and noConstraint::updateInternalBounds().
|
inline |
Get mesh.
Definition at line 100 of file NURBS3DVolumeI.H.
References mesh_.
Referenced by declareRunTimeSelectionTable(), New(), NURBS3DVolume(), NURBS3DVolume(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical(), NURBS3DVolumeCartesian::TypeName(), and NURBS3DVolumeCylindrical::TypeName().
|
inline |
Get dictionary.
Definition at line 106 of file NURBS3DVolumeI.H.
References dict_.
Referenced by declareRunTimeSelectionTable(), controlPointsDefinition::New(), New(), NURBS3DVolume(), NURBS3DVolume(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical(), NURBS3DVolumeCartesian::TypeName(), and NURBS3DVolumeCylindrical::TypeName().
| void writeCps | ( | const fileName & | baseName = "cpsFile", |
| const bool | transform = true ) const |
Write control points on a cartesian coordinates system for visualization.
Definition at line 1958 of file NURBS3DVolume.C.
References activeDesignVariables_, basisU_, basisV_, cps_, cpsFolder_, Foam::endl(), forAll, Foam::Info, UPstream::master(), name_, Foam::transform(), and transformPointToCartesian().
Referenced by computeNewBoundaryPoints(), computeNewPoints(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), and NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical().
| void writeParamCoordinates | ( | ) | const |
Write parametric coordinates.
Definition at line 2008 of file NURBS3DVolume.C.
References parametricCoordinatesPtr_.
|
virtual |
Write the control points to support restart.
Reimplemented from baseIOdictionary.
Definition at line 2014 of file NURBS3DVolume.C.
|
protected |
Definition at line 79 of file NURBS3DVolume.H.
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeControlPointSensitivities(), computeMaxBoundaryDisplacement(), computeNewBoundaryPoints(), computeNewPoints(), computeParametricCoordinates(), dndbBasedSensitivities(), getDxCellsDb(), getDxDb(), makeFolders(), mesh(), NURBS3DVolume(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), NURBS3DVolumeCylindrical::NURBS3DVolumeCylindrical(), patchDxDb(), patchDxDbFace(), and NURBS3DVolumeCylindrical::updateLocalCoordinateSystem().
|
protected |
Definition at line 80 of file NURBS3DVolume.H.
Referenced by dict(), and NURBS3DVolume().
|
protected |
Definition at line 81 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), computeParametricCoordinates(), name(), NURBS3DVolume(), NURBS3DVolumeCylindrical::updateLocalCoordinateSystem(), and writeCps().
|
protected |
NURBS basis functions.
Definition at line 85 of file NURBS3DVolume.H.
Referenced by basisU(), confineBoundaryControlPoints(), confineInertControlPoints(), continuityRealatedConfinement(), coordinates(), getCPID(), getIJK(), nCPsPerDirection(), NURBS3DVolume(), nUSymmetry(), volumeDerivativeCP(), volumeDerivativeU(), volumeDerivativeV(), volumeDerivativeW(), and writeCps().
|
protected |
Definition at line 86 of file NURBS3DVolume.H.
Referenced by basisV(), confineBoundaryControlPoints(), confineInertControlPoints(), continuityRealatedConfinement(), coordinates(), getCPID(), getIJK(), nCPsPerDirection(), NURBS3DVolume(), nVSymmetry(), volumeDerivativeCP(), volumeDerivativeU(), volumeDerivativeV(), volumeDerivativeW(), and writeCps().
|
protected |
Definition at line 87 of file NURBS3DVolume.H.
Referenced by basisW(), confineBoundaryControlPoints(), confineInertControlPoints(), continuityRealatedConfinement(), coordinates(), nCPsPerDirection(), NURBS3DVolume(), nWSymmetry(), volumeDerivativeCP(), volumeDerivativeU(), volumeDerivativeV(), and volumeDerivativeW().
|
protected |
Max iterations for Newton-Raphson.
Definition at line 92 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), computeParametricCoordinates(), and NURBS3DVolume().
|
protected |
Tolerance for Newton-Raphson.
Definition at line 97 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), computeParametricCoordinates(), and NURBS3DVolume().
|
protected |
How many times to bound parametric coordinates until deciding it is outside the box.
Definition at line 103 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), computeParametricCoordinates(), and NURBS3DVolume().
|
protected |
The volumetric B-Splines control points.
Definition at line 108 of file NURBS3DVolume.H.
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeMaxBoundaryDisplacement(), computeNewBoundaryPoints(), computeNewPoints(), computeParametricCoordinates(), computeParametricCoordinates(), confineControlPoint(), confineControlPoint(), confineControlPointsDirections(), coordinates(), determineActiveDesignVariablesAndPoints(), findPointsInBox(), getControlPoints(), getControlPoints(), NURBS3DVolume(), setControlPoints(), volumeDerivativeU(), volumeDerivativeV(), volumeDerivativeW(), writeCps(), and writeData().
Map of points-in-box to mesh points.
Definition at line 113 of file NURBS3DVolume.H.
Referenced by computeNewPoints(), computeParametricCoordinates(), coordinates(), findPointsInBox(), getDxCellsDb(), getDxDb(), getMap(), getParametricCoordinates(), getPointsInBox(), and NURBS3DVolume().
Map of mesh points to points-in-box.
Return -1 if point not within the box
Definition at line 120 of file NURBS3DVolume.H.
Referenced by computeControlPointSensitivities(), computeControlPointSensitivities(), computeControlPointSensitivities(), computeMaxBoundaryDisplacement(), computeNewBoundaryPoints(), computeParametricCoordinates(), dndbBasedSensitivities(), findPointsInBox(), getReverseMap(), NURBS3DVolume(), patchDxDb(), and patchDxDbFace().
|
protected |
Parametric coordinates of pointsInBox.
Definition at line 125 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), getParametricCoordinates(), NURBS3DVolume(), and writeParamCoordinates().
|
protected |
Coordinates in the local system for which CPs are defined.
Definition at line 130 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates(), getMap(), getParametricCoordinates(), getPointsInBox(), getReverseMap(), NURBS3DVolume(), NURBS3DVolumeCartesian::NURBS3DVolumeCartesian(), NURBS3DVolumeCylindrical::transformationTensorDxDb(), NURBS3DVolumeCartesian::updateLocalCoordinateSystem(), and NURBS3DVolumeCylindrical::updateLocalCoordinateSystem().
|
protected |
Confine movement in certain directions and control points. Refers to the local system.
Definition at line 136 of file NURBS3DVolume.H.
Referenced by confineControlPointsDirections(), confineUMovement(), and NURBS3DVolume().
|
protected |
Definition at line 138 of file NURBS3DVolume.H.
Referenced by confineControlPointsDirections(), and confineVMovement().
|
protected |
Definition at line 140 of file NURBS3DVolume.H.
Referenced by confineControlPointsDirections(), and confineWMovement().
|
protected |
Definition at line 142 of file NURBS3DVolume.H.
Referenced by confineBoundaryControlPoints().
|
protected |
Which movement components to freeze in each plane.
Definition at line 147 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Definition at line 149 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Definition at line 151 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Definition at line 153 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Definition at line 155 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Definition at line 157 of file NURBS3DVolume.H.
Referenced by continuityRealatedConfinement().
|
protected |
Which of the cps are moved in an optimisation.
Definition at line 162 of file NURBS3DVolume.H.
Referenced by confineInertControlPoints(), determineActiveDesignVariablesAndPoints(), and getActiveCPs().
|
protected |
Which design variables are changed in an optimisation.
Definition at line 167 of file NURBS3DVolume.H.
Referenced by boundControlPointMovement(), confineControlPoint(), confineControlPoint(), confineControlPointsDirections(), confineInertControlPoints(), determineActiveDesignVariablesAndPoints(), getActiveDesignVariables(), and writeCps().
|
protected |
Folder to store control points.
Definition at line 172 of file NURBS3DVolume.H.
Referenced by makeFolders(), and writeCps().
|
protected |
Read parametric coordinates from file if present in the folder.
Definition at line 177 of file NURBS3DVolume.H.
Referenced by computeParametricCoordinates().
1.16.1 