Go to the documentation of this file.
58 template<
class Face>
class MeshedSurface;
110 void operator=(
const surfMesh&) =
delete;
222 virtual label
nFaces()
const;
225 virtual label
size()
const
315 template<
class Type,
class GeoMeshType = surfGeoMesh>
318 const word& fieldName,
326 template<
class Type,
class GeoMeshType = surfGeoMesh>
329 const word& fieldName,
362 const word& fileType,
readUpdateState
Enumeration defining the state of the mesh after a read update.
const fileName & pointsInstance() const
Return the current instance directory for points.
A helper class for storing points and faces with IO capabilities.
Defines the attributes of an object for which implicit objectRegistry management is supported,...
surfZoneList & storedZones()
Non-const access to the surface zones.
bool BoundaryMesh
Placeholder only, but do not remove - it is needed for GeoMesh.
A class for handling words, derived from Foam::string.
Wraps the normal objectRegistry with a local instance for surfaces.
A class for handling file names.
void storeField(const word &fieldName, const dimensionSet &dims, const Field< Type > &values)
Copy/store named field as face or point data (template parameter).
void clearGeom()
Clear geometry.
const vectorField & Sf() const
Return face area vectors (normals)
List< T > values(const HashTable< T, Key, Hash > &tbl, const bool doSort=false)
List of values from HashTable, optionally sorted.
faceList & storedFaces()
Non-const access to the faces.
void updateRefs()
Update point/face references.
faceCompactIOList & storedIOFaces()
Non-const access to the faces.
void clearPrimitives()
Clear primitive data (points, faces and cells)
virtual bool writeObject(IOstreamOption streamOpt, const bool valid) const
Write all components using given format, version and compression.
Abstract definition of a meshed surface defined by faces and points.
void write(const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
Write to file, choosing writer based on its extension.
virtual label size() const
Return number of faces.
A surface mesh consisting of general polygon faces that has IO capabilities and a registry for storin...
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
static word meshSubDir
Return the mesh sub-directory name (normally "surfMesh")
void clearFields()
Clear stored fields.
static const dictionary null
An empty dictionary, which is also the parent for all dictionaries.
Registry of regIOobjects.
void removeZones()
Remove surface zones.
writeOption
Enumeration defining the write options.
IOobject for a surfZoneList.
virtual readUpdateState readUpdate()
Update mesh based on the files saved in time directories.
virtual bool write(const bool valid=true) const
Write using setting from DB.
void addZones(const surfZoneList &zones, bool validate=true)
Add surface zones, optionally validating the zone coverage.
const Field< point_type > & faceAreas() const
Return face area vectors for patch.
void setInstance(const fileName &inst, IOobject::writeOption wOpt=IOobject::AUTO_WRITE)
Set the instance for mesh files.
The IOstreamOption is a simple container for options an IOstream can normally have.
virtual const faceList & faces() const
Return faces.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
virtual label nPoints() const
Return the number of raw points.
void removeFiles() const
Remove all files from mesh instance()
void clearOut()
Clear all geometry and addressing unnecessary for CFD.
const scalarField & magSf() const
Return face area magnitudes.
pointField & storedPoints()
Non-const access to global points.
const word & name() const noexcept
Return name.
void transfer(MeshedSurface< face > &surf, bool validate=false)
Transfer the contents of the argument and annul the argument.
void checkZones(const bool verbose=true)
Check the surface zone definitions.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
virtual ~surfMesh()
Destructor.
virtual const surfZoneList & surfZones() const
Return surface zones.
virtual const pointField & points() const
Return points.
pointIOField & storedIOPoints()
Non-const access to the points.
fileName meshDir() const
Return the local mesh directory (dbDir()/meshSubDir)
TypeName("surfMesh")
Declare type-name, virtual type (with debug switch)
void clearAddressing()
Clear addressing.
static const word null
An empty word.
const Field< scalar > & magFaceAreas() const
Return face area magnitudes for patch.
autoPtr< MeshedSurface< face > > releaseGeom()
Release the geometry and return as a MeshedSurface<face>.
const vectorField & Cf() const
Face centres.
surfMesh Mesh
Typedef required for GeoMesh.
StringType validate(const std::string &str, const UnaryPredicate &accept, const bool invert=false)
Return a copy of the input string with validated characters.
virtual label nFaces() const
Return the number of raw faces.
const Field< point_type > & faceCentres() const
Return face centres for patch.
void copySurface(const pointField &points, const faceList &faces, bool validate=false)
Update with new contents.
const fileName & facesInstance() const
Return the current instance directory for faces.
void setWriteOption(IOobject::writeOption wOpt)
Adjust the write option for all components.
A list of faces which address into the list of points.