A sampledSurface defined by the cell faces corresponding to a threshold value. More...
Public Member Functions | |
TypeName ("sampledThresholdCellFaces") | |
Runtime type information. More... | |
sampledThresholdCellFaces (const word &name, const polyMesh &, const dictionary &) | |
Construct from dictionary. More... | |
virtual | ~sampledThresholdCellFaces ()=default |
Destructor. More... | |
virtual bool | needsUpdate () const |
Does the surface need an update? More... | |
virtual bool | expire () |
Mark the surface as needing an update. More... | |
virtual bool | update () |
Update the surface as required. More... | |
virtual const pointField & | points () const |
Points of surface. More... | |
virtual const faceList & | faces () const |
Faces of surface. More... | |
virtual const labelList & | zoneIds () const |
Per-face zone/region information. More... | |
virtual const vectorField & | Sf () const |
Face area vectors (normals) More... | |
virtual const scalarField & | magSf () const |
Face area magnitudes. More... | |
virtual const vectorField & | Cf () const |
Face centres. More... | |
virtual tmp< scalarField > | sample (const interpolation< scalar > &sampler) const |
Sample volume field onto surface faces. More... | |
virtual tmp< vectorField > | sample (const interpolation< vector > &sampler) const |
Sample volume field onto surface faces. More... | |
virtual tmp< sphericalTensorField > | sample (const interpolation< sphericalTensor > &sampler) const |
Sample volume field onto surface faces. More... | |
virtual tmp< symmTensorField > | sample (const interpolation< symmTensor > &sampler) const |
Sample volume field onto surface faces. More... | |
virtual tmp< tensorField > | sample (const interpolation< tensor > &sampler) const |
Sample volume field onto surface faces. More... | |
virtual tmp< scalarField > | interpolate (const interpolation< scalar > &interpolator) const |
Interpolate volume field onto surface points. More... | |
virtual tmp< vectorField > | interpolate (const interpolation< vector > &interpolator) const |
Interpolate volume field onto surface points. More... | |
virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &interpolator) const |
Interpolate volume field onto surface points. More... | |
virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &interpolator) const |
Interpolate volume field onto surface points. More... | |
virtual tmp< tensorField > | interpolate (const interpolation< tensor > &interpolator) const |
Interpolate volume field onto surface points. More... | |
virtual void | print (Ostream &os, int level=0) const |
Print information. More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnFaces (const interpolation< Type > &sampler) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator) const |
![]() | |
TypeName ("sampledSurface") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
Declare run-time constructor selection table. More... | |
sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false) | |
Construct from name, mesh. More... | |
sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
autoPtr< sampledSurface > | clone () const |
Clone. More... | |
virtual | ~sampledSurface () |
Destructor - calls clearGeom() More... | |
const polyMesh & | mesh () const noexcept |
Access to the underlying mesh. More... | |
const word & | name () const noexcept |
Name of surface. More... | |
bool | enabled () const noexcept |
Surface is enabled. More... | |
bool | invariant () const noexcept |
Surface is invariant with geometry change (caution) More... | |
bool | isPointData () const noexcept |
Using interpolation to surface points. More... | |
virtual bool | isPointData (const bool on) |
Change point/cell representation, may trigger an expire(). More... | |
scalar | area () const |
The total surface area. More... | |
virtual bool | hasFaceIds () const |
If element ids/order of the original surface are available. More... | |
polySurface * | getRegistrySurface (const objectRegistry &obr, word lookupName="") const |
Get surface from registry if available. More... | |
polySurface * | storeRegistrySurface (objectRegistry &obr, word lookupName="") const |
Copy surface into registry. More... | |
bool | removeRegistrySurface (objectRegistry &obr, word lookupName="") const |
Remove surface from registry. More... | |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
Copy/store sampled field onto registered surface (if it exists) More... | |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
Move/store sampled field onto registered surface (if it exists) More... | |
surfMesh * | getSurfMesh (word lookupName="") const |
Get surface from registry if available. More... | |
surfMesh * | storeSurfMesh (word lookupName="") const |
Copy surface into registry. More... | |
bool | removeSurfMesh (word lookupName="") const |
Remove surface from registry. More... | |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
Copy/store sampled Face field onto surfMesh (if it exists) More... | |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
Move/store sampled Face field onto surfMesh (if it exists) More... | |
virtual bool | withSurfaceFields () const |
Can it sample surface-fields? More... | |
virtual tmp< scalarField > | sample (const surfaceScalarField &sField) const |
Sample surface field onto surface. More... | |
virtual tmp< vectorField > | sample (const surfaceVectorField &sField) const |
Sample surface field onto surface. More... | |
virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &sField) const |
Sample surface field onto surface. More... | |
virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &sField) const |
Sample surface field onto surface. More... | |
virtual tmp< tensorField > | sample (const surfaceTensorField &sField) const |
Sample surface field onto surface. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
bool | interpolate () const noexcept |
Same as isPointData() More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue) |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
template<class Type > | |
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) |
![]() | |
constexpr | meshedSurf () noexcept=default |
Default construct. More... | |
virtual | ~meshedSurf ()=default |
Destructor. More... | |
virtual const labelList & | faceIds () const |
Per-face identifier (eg, element Id) More... | |
![]() | |
MeshedSurface () | |
Default construct, an empty surface. More... | |
MeshedSurface (const MeshedSurface &surf) | |
Copy construct. More... | |
MeshedSurface (const UnsortedMeshedSurface< face > &surf) | |
Copy construct from an UnsortedMeshedSurface. More... | |
MeshedSurface (MeshedSurface &&surf) | |
Move construct. More... | |
MeshedSurface (UnsortedMeshedSurface< face > &&surf) | |
Move construct from an UnsortedMeshedSurface. More... | |
MeshedSurface (const pointField &pointLst, const UList< face > &faceLst, const UList< surfZone > &zoneLst) | |
Copy construct from components (points, faces, zones). More... | |
MeshedSurface (pointField &&pointLst, List< face > &&faceLst, const UList< surfZone > &zoneLst) | |
Move construct from components (points, faces). More... | |
MeshedSurface (const pointField &pointLst, const UList< face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
Copy construct from components (points, faces). More... | |
MeshedSurface (pointField &&pointLst, List< face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
Move construct from components (points, faces). More... | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false) | |
Construct from a boundary mesh with local points/faces. More... | |
MeshedSurface (const surfMesh &mesh) | |
Construct from a surfMesh. More... | |
MeshedSurface (const fileName &name) | |
Construct from file name (uses extension to determine type) More... | |
MeshedSurface (const fileName &name, const word &fileType) | |
Construct from file name and given file type. More... | |
MeshedSurface (Istream &is) | |
Construct from Istream. More... | |
MeshedSurface (const Time &runTime) | |
Construct from database (as surfMesh) with default name. More... | |
MeshedSurface (const Time &runTime, const word &surfName) | |
Construct from database (as surfMesh) with given surface name. More... | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true) | |
Read construct using IO to find the file location. More... | |
MeshedSurface (const MeshedSurface< face > &surf) | |
MeshedSurface (MeshedSurface< face > &&surf) | |
bool | read (const fileName &name, const word &fileType) |
Read from file. Chooses reader based on explicit extension. More... | |
virtual bool | read (const fileName &name) |
Read from file. Chooses reader based on detected extension. More... | |
virtual void | write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
Generic write routine. Chooses writer based on extension. More... | |
virtual void | write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
Generic write routine for given format type. More... | |
void | write (const Time &runTime, const word &surfName=word::null) const |
Write to database. More... | |
ClassName ("MeshedSurface") | |
Declare type-name (with debug switch) More... | |
declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name)) | |
virtual | ~MeshedSurface () |
Destructor. More... | |
declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options)) | |
label | size () const |
The surface size is the number of faces. More... | |
const List< face > & | surfFaces () const |
Return const access to the faces. More... | |
const labelList & | faceIds () const |
Return const access to faces ids. More... | |
const surfZoneList & | surfZones () const |
Const access to the surface zones. More... | |
const vectorField & | Sf () const |
Face area vectors (normals) More... | |
const scalarField & | magSf () const |
Face area magnitudes. More... | |
const vectorField & | Cf () const |
Face centres. More... | |
virtual void | clear () |
Clear all storage. More... | |
virtual void | addZones (const UList< surfZone > &, const bool cullEmpty=false) |
Add surface zones. More... | |
virtual void | addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false) |
Add surface zones. More... | |
virtual void | addZones (const labelUList &sizes, const bool cullEmpty=false) |
Add surface zones. More... | |
bool | addZonesToFaces () |
Propagate zone information on face regions. More... | |
bool | addZonesToFaces () |
Specialization for labelledTri. More... | |
bool | addZonesToFaces () |
virtual void | removeZones () |
Remove surface zones. More... | |
virtual void | movePoints (const pointField &newPoints) |
Move points. More... | |
virtual void | scalePoints (const scalar scaleFactor) |
Scale points. A non-positive factor is ignored. More... | |
virtual void | cleanup (const bool verbose) |
Remove invalid faces. More... | |
virtual void | compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null())) |
Remove unused points and renumber faces in local visit order. More... | |
virtual bool | stitchFaces (const scalar tol=SMALL, const bool verbose=false) |
virtual bool | checkFaces (const bool verbose=false) |
virtual label | nTriangles () const |
Count number of triangles. More... | |
virtual label | nTriangles (labelList &faceMap) const |
Count number of triangles, returning a face map of original ids. More... | |
virtual label | triangulate () |
Triangulate in-place, returning the number of triangles added. More... | |
virtual label | triangulate (labelList &faceMap) |
Triangulate in-place, returning the number of triangles added. More... | |
void | subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
Create mappings for a sub-surface. More... | |
MeshedSurface | subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const UList< bool > &include) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const bitSet &include) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const |
Return a new surface subsetted on the selected zone names. More... | |
void | swap (MeshedSurface< face > &surf) |
Swap contents. More... | |
void | transfer (pointField &pointLst, List< face > &faceLst) |
Transfer the components. More... | |
void | transfer (MeshedSurface< face > &surf) |
Transfer the contents of the argument and annul the argument. More... | |
void | transfer (UnsortedMeshedSurface< face > &surf) |
Transfer the contents of the argument and annul the argument. More... | |
autoPtr< MeshedSurface< face > > | releaseGeom () |
Release (clear) geometry and return for reuse. More... | |
void | swapFaces (List< face > &faces) |
Swap the stored faces. Use with caution. More... | |
void | swapPoints (pointField &points) |
Swap the stored points. More... | |
void | writeStats (Ostream &os) const |
void | operator= (const MeshedSurface< face > &surf) |
Copy assignment. More... | |
void | operator= (MeshedSurface< face > &&surf) |
Move assignment. More... | |
operator MeshedSurfaceProxy< face > () const | |
Conversion operator to MeshedSurfaceProxy. More... | |
Additional Inherited Members | |
![]() | |
typedef face | face_type |
The face type (same as the underlying PrimitivePatch) More... | |
typedef point | point_type |
The point type (same as the underlying PrimitivePatch) More... | |
![]() | |
static autoPtr< sampledSurface > | New (const word &name, const polyMesh &mesh, const dictionary &dict) |
Return a reference to the selected surface. More... | |
![]() | |
static void | write (const fileName &name, const MeshedSurface< face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
Write to file, selecting writer based on its extension. More... | |
static void | write (const fileName &name, const word &fileType, const MeshedSurface< face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
Write to file, selecting writer based on the given extension. More... | |
static wordHashSet | readTypes () |
Known readable file-types, without friends or proxies. More... | |
static wordHashSet | writeTypes () |
Known writable file-types, without friends or proxies. More... | |
static bool | canReadType (const word &fileType, bool verbose=false) |
Can we read this file format? Also checks friend types. More... | |
static bool | canWriteType (const word &fileType, bool verbose=false) |
Can we write this file format? Also checks proxy types. More... | |
static bool | canRead (const fileName &name, bool verbose=false) |
Can we read this file format? More... | |
static autoPtr< MeshedSurface > | New (const fileName &name, const word &fileType, bool mandatory=true) |
Read construct from filename with given file type. More... | |
static autoPtr< MeshedSurface > | New (const fileName &name) |
Read construct from filename (file type implicit from extension) More... | |
![]() | |
static const wordList | surfaceFieldTypes |
Class names for surface field types. More... | |
![]() | |
virtual void | clearGeom () const |
Additional cleanup when clearing the geometry. More... | |
sampledSurface (const word &name, std::nullptr_t) | |
Construct null. More... | |
![]() | |
void | transcribe (MeshedSurface< face > &surf) |
Transfer points/zones from 'face' to other other shapes. More... | |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
void | checkZones (const bool verbose=true) |
Sanity check/resizing on zones. More... | |
pointField & | storedPoints () |
Non-const access to global points. More... | |
List< face > & | storedFaces () |
Non-const access to the faces. More... | |
labelList & | storedFaceIds () |
Non-const access to face ids. More... | |
surfZoneList & | storedZones () |
Non-const access to the zones. More... | |
void | sortFacesAndStore (DynamicList< face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted) |
Sort faces by zones and store sorted faces. More... | |
virtual void | remapFaces (const labelUList &faceMapNewToOld) |
Set new zones from faceMap. More... | |
![]() | |
template<class Type > | |
static tmp< Field< Type > > | sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue=Type(Zero)) |
Loop for sampling volume elements to faces. More... | |
template<class Type > | |
static tmp< Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
Loop for interpolating volume elements to face points. More... | |
template<class Type > | |
static tmp< GeometricField< Type, fvPatchField, volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) |
Create cell values by averaging the point values. More... | |
A sampledSurface defined by the cell faces corresponding to a threshold value.
This is often embedded as part of a sampled surfaces function object.
surfaces { surface1 { type thresholdCellFaces; field rho; lowerLimit 0.1; } }
Where the sub-entries comprise:
Property | Description | Required | Default |
---|---|---|---|
type | thresholdCellFaces | yes | |
field | field name for threshold | yes | |
lowerLimit | lower limit for threshold | partly | -Inf |
upperLimit | upper limit for threshold | partly | +Inf |
triangulate | triangulate faces | no | false |
lowerLimit
or upperLimit
Definition at line 116 of file sampledThresholdCellFaces.H.
sampledThresholdCellFaces | ( | const word & | name, |
const polyMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 146 of file sampledThresholdCellFaces.C.
References Foam::abort(), dict, Foam::endl(), Foam::FatalError, FatalErrorInFunction, and dictionary::found().
|
virtualdefault |
Destructor.
TypeName | ( | "sampledThresholdCellFaces" | ) |
Runtime type information.
|
virtual |
Does the surface need an update?
Implements sampledSurface.
Definition at line 171 of file sampledThresholdCellFaces.C.
References mesh, fvMesh::time(), and TimeState::timeIndex().
|
virtual |
Mark the surface as needing an update.
May also free up unneeded data. Return false if surface was already marked as expired.
Implements sampledSurface.
Definition at line 179 of file sampledThresholdCellFaces.C.
|
virtual |
Update the surface as required.
Do nothing (and return false) if no update was needed
Implements sampledSurface.
Definition at line 193 of file sampledThresholdCellFaces.C.
|
inlinevirtual |
Points of surface.
Implements sampledSurface.
Definition at line 205 of file sampledThresholdCellFaces.H.
References points.
|
inlinevirtual |
Faces of surface.
Implements sampledSurface.
Definition at line 211 of file sampledThresholdCellFaces.H.
References MeshedSurface< face >::surfFaces().
|
inlinevirtual |
Per-face zone/region information.
Reimplemented from meshedSurf.
Definition at line 217 of file sampledThresholdCellFaces.H.
References List< T >::null().
|
inlinevirtual |
Face area vectors (normals)
Implements sampledSurface.
Definition at line 223 of file sampledThresholdCellFaces.H.
References MeshedSurface< face >::Sf().
|
inlinevirtual |
Face area magnitudes.
Implements sampledSurface.
Definition at line 229 of file sampledThresholdCellFaces.H.
References MeshedSurface< face >::magSf().
|
inlinevirtual |
Face centres.
Implements sampledSurface.
Definition at line 235 of file sampledThresholdCellFaces.H.
References MeshedSurface< face >::Cf().
|
virtual |
Sample volume field onto surface faces.
Implements sampledSurface.
Definition at line 200 of file sampledThresholdCellFaces.C.
|
virtual |
Sample volume field onto surface faces.
Implements sampledSurface.
Definition at line 209 of file sampledThresholdCellFaces.C.
|
virtual |
Sample volume field onto surface faces.
Implements sampledSurface.
Definition at line 218 of file sampledThresholdCellFaces.C.
|
virtual |
Sample volume field onto surface faces.
Implements sampledSurface.
Definition at line 227 of file sampledThresholdCellFaces.C.
|
virtual |
Sample volume field onto surface faces.
Implements sampledSurface.
Definition at line 236 of file sampledThresholdCellFaces.C.
|
virtual |
Interpolate volume field onto surface points.
Implements sampledSurface.
Definition at line 245 of file sampledThresholdCellFaces.C.
|
virtual |
Interpolate volume field onto surface points.
Implements sampledSurface.
Definition at line 254 of file sampledThresholdCellFaces.C.
|
virtual |
Interpolate volume field onto surface points.
Implements sampledSurface.
Definition at line 263 of file sampledThresholdCellFaces.C.
|
virtual |
Interpolate volume field onto surface points.
Implements sampledSurface.
Definition at line 272 of file sampledThresholdCellFaces.C.
|
virtual |
Interpolate volume field onto surface points.
Implements sampledSurface.
Definition at line 281 of file sampledThresholdCellFaces.C.
|
virtual |
Print information.
Reimplemented from sampledSurface.
Definition at line 289 of file sampledThresholdCellFaces.C.
References Foam::name(), and os().
Foam::tmp<Foam::Field<Type> > sampleOnFaces | ( | const interpolation< Type > & | sampler | ) | const |
Definition at line 41 of file sampledThresholdCellFacesTemplates.C.
References points.
Foam::tmp<Foam::Field<Type> > sampleOnPoints | ( | const interpolation< Type > & | interpolator | ) | const |
Definition at line 60 of file sampledThresholdCellFacesTemplates.C.
References points.