Class constructing a number of volumetric B-Splines boxes, read from dynamicMeshDict. Useful for various sensitivities and optMeshMovement classes. More...
Public Member Functions | |
| TypeName ("volBSplinesBase") | |
| Runtime type information. More... | |
| volBSplinesBase (const fvMesh &mesh) | |
| Construct from components. More... | |
| virtual | ~volBSplinesBase ()=default |
| Destructor. More... | |
| const PtrList< NURBS3DVolume > & | boxes () const |
| Get const reference to the vol. B-splines boxes. More... | |
| PtrList< NURBS3DVolume > & | boxesRef () |
| Get non-const reference to the vol. B-splines boxes. More... | |
| const NURBS3DVolume & | box (const label boxI) const |
| Get const reference to a specific box. More... | |
| NURBS3DVolume & | boxRef (const label boxI) |
| Get non-const reference to a specific box. More... | |
| const vectorField & | getControlPoints (const label &iNURB) const |
| Get reference to control points. More... | |
| vectorField | getAllControlPoints () const |
| Get control points from all boxes. More... | |
| label | getTotalControlPointsNumber () const |
| Get cumulative number of control points from all boxes. More... | |
| label | getNumberOfBoxes () const |
| Get number of boxes. More... | |
| labelList | getStartCpID () const |
| Get start CP ID for each box. More... | |
| label | findBoxID (const label cpI) const |
| Find box of certain control point. More... | |
| const labelList & | getActiveDesignVariables () const |
| Get active design variables. More... | |
| scalar | computeMaxBoundaryDisplacement (const vectorField &controlPointsMovement, const labelList &patchesToBeMoved) |
| void | boundControlPointMovement (vectorField &controlPointsMovement) |
| Bound control points movement. More... | |
| void | moveControlPoints (const vectorField &controlPointsMovement) |
| Move control points. No effect on mesh. More... | |
| void | writeControlPoints () const |
| Write control points to constant and optimisation folders. More... | |
| virtual bool | movePoints () |
| Dummy function required by MeshObject. More... | |
| virtual void | updateMesh (const mapPolyMesh &) |
| Dummy function required by MeshObject. More... | |
 Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase > | |
| MeshObject (const fvMesh &mesh) | |
| Construct on Mesh type. More... | |
| virtual | ~MeshObject ()=default |
| Destructor. More... | |
| const fvMesh & | mesh () const |
| virtual bool | writeData (Ostream &os) const |
| Public Member Functions inherited from UpdateableMeshObject< fvMesh > | |
| UpdateableMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from MoveableMeshObject< fvMesh > | |
| MoveableMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from GeometricMeshObject< fvMesh > | |
| GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from TopologicalMeshObject< fvMesh > | |
| TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from meshObject | |
| ClassName ("meshObject") | |
| meshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More... | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. More... | |
| void | removeMetaData () |
| Remove meta-data. More... | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | readData (Istream &) |
| Virtual readData function. More... | |
| virtual bool | read () |
| Read object. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return name. More... | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More... | |
| word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const noexcept |
| Return the optional note. More... | |
| string & | note () noexcept |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More... | |
| bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More... | |
| bool | globalObject () const noexcept |
| Is object same for all processors? More... | |
| bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More... | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More... | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const noexcept |
| The read option. More... | |
| readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More... | |
| writeOption | writeOpt () const noexcept |
| The write option. More... | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | objectRelPath () const |
| The object path relative to the root. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| bool | readHeader (Istream &is) |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type() More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More... | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| bool | good () const noexcept |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| readOption & | readOpt () noexcept |
| Access to the read option. More... | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. More... | |
| bool & | registerObject () noexcept |
| Access to the register object option. More... | |
| bool & | globalObject () noexcept |
| Access to the global object option. More... | |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
Protected Attributes | |
| PtrList< NURBS3DVolume > | volume_ |
| List with volumetric B-splines boxes. More... | |
| labelList | activeDesignVariables_ |
| Active design variables numbering for all boxes. More... | |
| Protected Attributes inherited from MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase > | |
| const fvMesh & | mesh_ |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase > | |
| static const volBSplinesBase & | New (const fvMesh &mesh, Args &&... args) |
| Get existing or create a new MeshObject. More... | |
| static bool | Delete (const fvMesh &mesh) |
| Static destructor. More... | |
| Static Public Member Functions inherited from meshObject | |
| template<class Mesh > | |
| static void | movePoints (objectRegistry &obr) |
| template<class Mesh > | |
| static void | updateMesh (objectRegistry &obr, const mapPolyMesh &mpm) |
| template<class Mesh , template< class > class MeshObjectType> | |
| static void | clear (objectRegistry &obr) |
| template<class Mesh , template< class > class FromType, template< class > class ToType> | |
| static void | clearUpto (objectRegistry &obr) |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. More... | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable an output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More... | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Class constructing a number of volumetric B-Splines boxes, read from dynamicMeshDict. Useful for various sensitivities and optMeshMovement classes.
Derives from MeshObject so that all instances know and update the same control points and parametric coordinates are computed only once
Definition at line 59 of file volBSplinesBase.H.
| volBSplinesBase | ( | const fvMesh & | mesh | ) |
Construct from components.
Definition at line 44 of file volBSplinesBase.C.
References TimePaths::constant(), forAll, mesh, IOobject::MUST_READ_IF_MODIFIED, NURBS3DVolume::New(), IOobject::NO_WRITE, List< T >::setSize(), dictionary::subDict(), and fvMesh::time().
|
virtualdefault |
Destructor.
| TypeName | ( | "volBSplinesBase" | ) |
Runtime type information.
| const PtrList< NURBS3DVolume > & boxes | ( | ) | const |
Get const reference to the vol. B-splines boxes.
Definition at line 115 of file volBSplinesBase.C.
References volBSplinesBase::volume_.
| PtrList< NURBS3DVolume > & boxesRef | ( | ) |
Get non-const reference to the vol. B-splines boxes.
Definition at line 121 of file volBSplinesBase.C.
References volBSplinesBase::volume_.
Referenced by sensitivityVolBSplines::assembleSensitivities(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityVolBSplines::computeBCContributions(), sensitivityVolBSplines::computeObjectiveContributions(), volumetricBSplinesMotionSolver::curPoints(), sensitivityVolBSplines::write(), and sensitivityVolBSplinesFI::write().
| const NURBS3DVolume & box | ( | const label | boxI | ) | const |
Get const reference to a specific box.
Definition at line 127 of file volBSplinesBase.C.
References volBSplinesBase::volume_.
| NURBS3DVolume & boxRef | ( | const label | boxI | ) |
Get non-const reference to a specific box.
Definition at line 133 of file volBSplinesBase.C.
References volBSplinesBase::volume_.
| const vectorField & getControlPoints | ( | const label & | iNURB | ) | const |
Get reference to control points.
Definition at line 139 of file volBSplinesBase.C.
References volBSplinesBase::volume_.
Referenced by volBSplinesBase::getAllControlPoints().
| vectorField getAllControlPoints | ( | ) | const |
Get control points from all boxes.
Definition at line 145 of file volBSplinesBase.C.
References forAll, volBSplinesBase::getControlPoints(), and volBSplinesBase::volume_.
| Foam::label getTotalControlPointsNumber | ( | ) | const |
Get cumulative number of control points from all boxes.
Definition at line 157 of file volBSplinesBase.C.
References forAll.
| label getNumberOfBoxes | ( | ) | const |
Get number of boxes.
Definition at line 169 of file volBSplinesBase.C.
Referenced by volBSplinesBase::getStartCpID().
| labelList getStartCpID | ( | ) | const |
Get start CP ID for each box.
Definition at line 175 of file volBSplinesBase.C.
References forAll, volBSplinesBase::getNumberOfBoxes(), and volBSplinesBase::volume_.
Referenced by volBSplinesBase::findBoxID().
| label findBoxID | ( | const label | cpI | ) | const |
Find box of certain control point.
Definition at line 190 of file volBSplinesBase.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and volBSplinesBase::getStartCpID().
| const Foam::labelList & getActiveDesignVariables | ( | ) | const |
Get active design variables.
Definition at line 208 of file volBSplinesBase.C.
References volBSplinesBase::activeDesignVariables_.
| Foam::scalar computeMaxBoundaryDisplacement | ( | const vectorField & | controlPointsMovement, |
| const labelList & | patchesToBeMoved | ||
| ) |
Get max boundary displacement for a given control-points movement
Definition at line 215 of file volBSplinesBase.C.
References forAll, Foam::max(), and Foam::Zero.
| void boundControlPointMovement | ( | vectorField & | controlPointsMovement | ) |
Bound control points movement.
Definition at line 252 of file volBSplinesBase.C.
References forAll, and Foam::Zero.
Referenced by sensitivityVolBSplines::assembleSensitivities(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityVolBSplines::computeBCContributions(), and sensitivityVolBSplines::computeObjectiveContributions().
| void moveControlPoints | ( | const vectorField & | controlPointsMovement | ) |
Move control points. No effect on mesh.
Definition at line 284 of file volBSplinesBase.C.
References forAll, and Foam::Zero.
Referenced by optMeshMovementVolumetricBSplinesExternalMotionSolver::moveMesh().
| void writeControlPoints | ( | ) | const |
Write control points to constant and optimisation folders.
Definition at line 314 of file volBSplinesBase.C.
Referenced by optMeshMovementVolumetricBSplinesExternalMotionSolver::moveMesh().
|
virtual |
Dummy function required by MeshObject.
Since this class is going to initiate the mesh movement, there is nothing more to be done when the mesh points change
Implements MoveableMeshObject< fvMesh >.
Definition at line 324 of file volBSplinesBase.C.
|
virtual |
Dummy function required by MeshObject.
Since this class is going to initiate the mesh movement, there is nothing more to be done when the mesh points change
Implements UpdateableMeshObject< fvMesh >.
Definition at line 331 of file volBSplinesBase.C.
|
protected |
List with volumetric B-splines boxes.
No overlapping is supported
Definition at line 69 of file volBSplinesBase.H.
Referenced by volBSplinesBase::box(), volBSplinesBase::boxes(), volBSplinesBase::boxesRef(), volBSplinesBase::boxRef(), volBSplinesBase::getAllControlPoints(), volBSplinesBase::getControlPoints(), and volBSplinesBase::getStartCpID().
|
protected |
Active design variables numbering for all boxes.
Definition at line 72 of file volBSplinesBase.H.
Referenced by volBSplinesBase::getActiveDesignVariables().
1.8.17 