File size: 7,159 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::DemandDrivenMeshObject
Description
Templated abstract base-class for demand-driven mesh objects used to
automate their allocation to the mesh database and the m esh-modifier
event-loop.
DemandDrivenMeshObject is templated on the type of mesh it is allocated to,
the type of the mesh object (DeletableMeshObject, MoveableMeshObject,
DistributeableMeshObject, TopoChangeableMeshObject), the type of the object
it is created for and optionally the type of registered object
which defaults to regIOobject, e.g.:
\verbatim
class leastSquaresVectors
:
public DemandDrivenMeshObject
<
fvMesh,
MoveableMeshObject,
leastSquaresVectors
>
{
.
.
.
//- Delete the least square vectors when the mesh moves
virtual bool movePoints();
};
\endverbatim
or if the object is read from a special IOdictionary it can be derived
from an IOdictionary stored by the DemandDrivenMeshObject, e.g.:
\verbatim
class fvModels
:
public DemandDrivenMeshObject
<
fvMesh,
TopoChangeableMeshObject,
fvModels,
IOdictionary
>,
public PtrList<MRFZone>
{
.
.
.
};
\endverbatim
MeshObject types:
- DeletableMeshObject:
mesh object to be deleted after any mesh change
- MoveableMeshObject:
mesh object to be updated after mesh motion otherwise deleted
- DistributeableMeshObject
mesh object to be updated after mesh redistribution or motion
otherwise deleted
- TopoChangeableMeshObject:
mesh object to be updated after mesh topology change,
mesh-to-mesh mapping, redistribution or motion otherwise deleted
- RepatchableMeshObject:
mesh object to be updated on patch or topology change,
mesh-to-mesh mapping, redistribution or motion otherwise deleted
DemandDrivenMeshObject should always be constructed and accessed via the New
methods provided so that they are held and maintained by the objectRegistry.
To ensure this use constructors of the concrete derived types should be
private or protected and friendship with the DemandDrivenMeshObject
base-class declared so that the New functions can call the the constructors.
SourceFiles
DemandDrivenMeshObject.C
\*---------------------------------------------------------------------------*/
#ifndef DemandDrivenMeshObject_H
#define DemandDrivenMeshObject_H
#include "MeshObjects.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class DemandDrivenMeshObject Declaration
\*---------------------------------------------------------------------------*/
template
<
class Mesh,
template<class> class MeshObjectType,
class Type,
class RegIOobject = regIOobject
>
class DemandDrivenMeshObject
:
public RegIOobject,
public MeshObjectType<Mesh>
{
// Private Data
// Reference to Mesh
const Mesh& mesh_;
protected:
// Constructors
//- Construct from mesh and IOobject
// Only derived classes can construct DemandDrivenMeshObject
DemandDrivenMeshObject(const IOobject& io, const Mesh& mesh);
//- Construct from mesh and name
// Only derived classes can construct DemandDrivenMeshObject
DemandDrivenMeshObject(const word& name, const Mesh& mesh);
//- Construct from mesh, the name is set to Type::typeName
// Only derived classes can construct DemandDrivenMeshObject
DemandDrivenMeshObject(const Mesh& mesh);
public:
//- Runtime type information
virtual const word& type() const;
// Constructors
//- Construct and return the named DemandDrivenMeshObject
static Type& New(const word& name, const Mesh& mesh);
//- Construct and return the DemandDrivenMeshObject named Type::typeName
static Type& New(const Mesh& mesh);
//- Construct and return the named DemandDrivenMeshObject
// with the additional arguments
template<class... Args>
static Type& New
(
const word& name,
const Mesh& mesh,
const Args&... args
);
//- Construct and return the DemandDrivenMeshObject named Type::typeName
// with the additional arguments
template<class... Args>
static Type& New
(
const Mesh& mesh,
const Args&... args
);
// Destructors
virtual ~DemandDrivenMeshObject();
// Member Functions
//- Return true if the DemandDrivenMeshObject with the given name
// is found in the mesh registry
static bool found(const word& name, const Mesh& mesh);
//- Return true if the DemandDrivenMeshObject named Type::typeName
// is found in the mesh registry
static bool found(const Mesh& mesh);
const Mesh& mesh() const
{
return mesh_;
}
virtual bool writeData(Foam::Ostream&) const
{
return true;
}
//- Write using given format, version and compression
virtual bool writeObject
(
IOstream::streamFormat,
IOstream::versionNumber,
IOstream::compressionType,
const bool write
) const
{
return true;
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "DemandDrivenMeshObject.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|