A sampledSurface from a meshed surface. It samples on the points/faces of the meshed surface. More...
Public Types | |
enum | samplingSource : unsigned char { cells, insideCells, boundaryFaces } |
![]() | |
typedef Face | face_type |
typedef point | point_type |
Public Member Functions | |
TypeName ("sampledMeshedSurface") | |
sampledMeshedSurface (const word &name, const polyMesh &mesh, const word &surfaceName, const samplingSource sampleSource) | |
sampledMeshedSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
virtual | ~sampledMeshedSurface ()=default |
virtual bool | needsUpdate () const |
virtual bool | expire () |
virtual bool | update () |
bool | update (const treeBoundBox &bb) |
virtual const pointField & | points () const |
virtual const faceList & | faces () const |
virtual const labelList & | zoneIds () const |
virtual const labelList & | faceIds () const |
virtual const vectorField & | Sf () const |
virtual const scalarField & | magSf () const |
virtual const vectorField & | Cf () const |
virtual bool | hasFaceIds () const |
bool | onBoundary () const |
virtual tmp< scalarField > | sample (const interpolation< scalar > &sampler) const |
virtual tmp< vectorField > | sample (const interpolation< vector > &sampler) const |
virtual tmp< sphericalTensorField > | sample (const interpolation< sphericalTensor > &sampler) const |
virtual tmp< symmTensorField > | sample (const interpolation< symmTensor > &sampler) const |
virtual tmp< tensorField > | sample (const interpolation< tensor > &sampler) const |
virtual tmp< scalarField > | interpolate (const interpolation< scalar > &interpolator) const |
virtual tmp< vectorField > | interpolate (const interpolation< vector > &interpolator) const |
virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &interpolator) const |
virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &interpolator) const |
virtual tmp< tensorField > | interpolate (const interpolation< tensor > &interpolator) const |
virtual void | print (Ostream &os, int level=0) const |
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") | |
declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false) | |
sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
autoPtr< sampledSurface > | clone () const |
virtual | ~sampledSurface () |
const polyMesh & | mesh () const noexcept |
const word & | name () const noexcept |
bool | enabled () const noexcept |
bool | invariant () const noexcept |
bool | isPointData () const noexcept |
virtual bool | isPointData (const bool on) |
scalar | area () const |
polySurface * | getRegistrySurface (const objectRegistry &obr, word lookupName="") const |
polySurface * | storeRegistrySurface (objectRegistry &obr, word lookupName="") const |
bool | removeRegistrySurface (objectRegistry &obr, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
surfMesh * | getSurfMesh (word lookupName="") const |
surfMesh * | storeSurfMesh (word lookupName="") const |
bool | removeSurfMesh (word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
virtual bool | withSurfaceFields () const |
virtual tmp< scalarField > | sample (const surfaceScalarField &sField) const |
virtual tmp< vectorField > | sample (const surfaceVectorField &sField) const |
virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &sField) const |
virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &sField) const |
virtual tmp< tensorField > | sample (const surfaceTensorField &sField) const |
virtual void | rename (const word &newName) |
bool | interpolate () const noexcept |
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 |
virtual | ~meshedSurf ()=default |
![]() | |
ClassName ("MeshedSurface") | |
MeshedSurface () | |
MeshedSurface (const MeshedSurface &surf) | |
MeshedSurface (const UnsortedMeshedSurface< Face > &surf) | |
MeshedSurface (MeshedSurface &&surf) | |
MeshedSurface (UnsortedMeshedSurface< Face > &&surf) | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst) | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst) | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false) | |
MeshedSurface (const surfMesh &mesh) | |
MeshedSurface (const fileName &name) | |
MeshedSurface (const fileName &name, const word &fileType) | |
MeshedSurface (Istream &is) | |
MeshedSurface (const Time &runTime) | |
MeshedSurface (const Time &runTime, const word &surfName) | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true) | |
declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name)) | |
virtual | ~MeshedSurface () |
declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options)) | |
label | size () const |
const List< Face > & | surfFaces () const |
const labelList & | faceIds () const |
const surfZoneList & | surfZones () const |
const vectorField & | Sf () const |
const scalarField & | magSf () const |
const vectorField & | Cf () const |
virtual void | clear () |
virtual void | addZones (const UList< surfZone > &, const bool cullEmpty=false) |
virtual void | addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false) |
virtual void | addZones (const labelUList &sizes, const bool cullEmpty=false) |
bool | addZonesToFaces () |
virtual void | removeZones () |
virtual void | movePoints (const pointField &newPoints) |
virtual void | scalePoints (const scalar scaleFactor) |
virtual void | cleanup (const bool verbose) |
virtual void | compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null())) |
virtual bool | stitchFaces (const scalar tol=SMALL, const bool verbose=false) |
virtual bool | checkFaces (const bool verbose=false) |
virtual label | nTriangles () const |
virtual label | nTriangles (labelList &faceMap) const |
virtual label | triangulate () |
virtual label | triangulate (labelList &faceMap) |
template<class BoolListType > | |
void | subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const UList< bool > &include) const |
MeshedSurface | subsetMesh (const bitSet &include) const |
MeshedSurface | subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const |
void | swap (MeshedSurface< Face > &surf) |
void | transfer (pointField &pointLst, List< Face > &faceLst) |
void | transfer (MeshedSurface< Face > &surf) |
void | transfer (UnsortedMeshedSurface< Face > &surf) |
autoPtr< MeshedSurface< Face > > | releaseGeom () |
void | swapFaces (List< Face > &faces) |
void | swapPoints (pointField &points) |
bool | read (const fileName &name, const word &fileType) |
virtual bool | read (const fileName &name) |
void | writeStats (Ostream &os) const |
virtual void | write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
virtual void | write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
void | write (const Time &runTime, const word &surfName=word::null) const |
void | operator= (const MeshedSurface< Face > &surf) |
void | operator= (MeshedSurface< Face > &&surf) |
operator MeshedSurfaceProxy< Face > () const | |
template<class Face > | |
MeshedSurface () | |
template<class Face > | |
MeshedSurface (const MeshedSurface< Face > &surf) | |
template<class Face > | |
MeshedSurface (const UnsortedMeshedSurface< Face > &surf) | |
template<class Face > | |
MeshedSurface (MeshedSurface< Face > &&surf) | |
template<class Face > | |
MeshedSurface (UnsortedMeshedSurface< Face > &&surf) | |
template<class Face > | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst) | |
template<class Face > | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst) | |
template<class Face > | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames) | |
template<class Face > | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames) | |
template<class Face > | |
MeshedSurface (const surfMesh &mesh) | |
template<class Face > | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool useGlobalPoints) | |
template<class Face > | |
MeshedSurface (const fileName &name, const word &fileType) | |
template<class Face > | |
MeshedSurface (const fileName &name) | |
template<class Face > | |
MeshedSurface (Istream &is) | |
template<class Face > | |
MeshedSurface (const Time &runTime) | |
template<class Face > | |
MeshedSurface (const Time &runTime, const word &surfName) | |
template<class Face > | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal) | |
bool | addZonesToFaces () |
bool | addZonesToFaces () |
Additional Inherited Members | |
![]() | |
static autoPtr< sampledSurface > | New (const word &name, const polyMesh &mesh, const dictionary &dict) |
![]() | |
static wordHashSet | readTypes () |
static wordHashSet | writeTypes () |
static bool | canReadType (const word &fileType, bool verbose=false) |
static bool | canWriteType (const word &fileType, bool verbose=false) |
static bool | canRead (const fileName &name, bool verbose=false) |
static autoPtr< MeshedSurface > | New (const fileName &name, const word &fileType, bool mandatory=true) |
static autoPtr< MeshedSurface > | New (const fileName &name) |
static void | write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
static void | write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
![]() | |
static const wordList | surfaceFieldTypes |
![]() | |
virtual void | clearGeom () const |
sampledSurface (const word &name, std::nullptr_t) | |
![]() | |
void | transcribe (MeshedSurface< face > &surf) |
void | checkZones (const bool verbose=true) |
pointField & | storedPoints () |
List< Face > & | storedFaces () |
labelList & | storedFaceIds () |
surfZoneList & | storedZones () |
void | sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted) |
virtual void | remapFaces (const labelUList &faceMapNewToOld) |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
![]() | |
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)) |
template<class Type > | |
static tmp< Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
template<class Type > | |
static tmp< GeometricField< Type, fvPatchField, volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) |
A sampledSurface from a meshed surface. It samples on the points/faces of the meshed surface.
This is often embedded as part of a sampled surfaces function object.
surfaces { surface1 { type meshedSurface; surface something.obj; source cells; //- Max sampling distance maxDistance 0.005; //- Fallback for missed sampling in 'cells' mode defaultValue { "p.*" 1e5; T 273.15; } } }
Where the sub-entries comprise:
Property | Description | Required | Default |
---|---|---|---|
type | meshedSurface | yes | |
surface | surface name in triSurface/ | yes | |
patches | Limit to named surface regions (wordRes) | no | |
source | cells/insideCells/boundaryFaces | yes | |
keepIds | pass through id numbering | no | true |
file | Alternative file name | no | |
fileType | The surface format | no | (extension) |
scale | Surface scaling factor | no | 0 |
maxDistance | Max search distance | no | GREAT |
defaultValue | Value beyond max distance (dictionary) | no | empty |
Definition at line 184 of file sampledMeshedSurface.H.
|
strong |
Enumerator | |
---|---|
cells | Use nearest cell value. |
insideCells | Surface face within a cell, or trim. |
boundaryFaces | Use nearest boundary face values. |
Definition at line 192 of file sampledMeshedSurface.H.
sampledMeshedSurface | ( | const word & | name, |
const polyMesh & | mesh, | ||
const word & | surfaceName, | ||
const samplingSource | sampleSource | ||
) |
Definition at line 459 of file sampledMeshedSurface.C.
sampledMeshedSurface | ( | const word & | name, |
const polyMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Definition at line 486 of file sampledMeshedSurface.C.
References bitSet::all(), dict, Foam::stringListOps::findMatching(), Foam::flatOutput(), Foam::Info, Foam::nl, bitSet::none(), surfZone::range(), dictionary::readIfPresent(), bitSet::set(), Foam::sqr(), wordRes::uniq(), and WarningInFunction.
|
virtualdefault |
TypeName | ( | "sampledMeshedSurface" | ) |
|
virtual |
Implements sampledSurface.
Definition at line 593 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Definition at line 599 of file sampledMeshedSurface.C.
References MeshedSurface::clear(), and sampledSurface::clearGeom().
|
virtual |
Implements sampledSurface.
Definition at line 619 of file sampledMeshedSurface.C.
References polyMesh::bounds(), Foam::constant::electromagnetic::e, Foam::endl(), polyMesh::FACE_PLANES, boundBox::inflate(), boundBox::intersect(), boundBox::max(), mesh, boundBox::min(), boundBox::span(), update(), and WarningInFunction.
bool update | ( | const treeBoundBox & | bb | ) |
Definition at line 665 of file sampledMeshedSurface.C.
References polyMesh::FACE_PLANES, mesh, and update().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 311 of file sampledMeshedSurface.H.
References points.
|
inlinevirtual |
Implements sampledSurface.
Definition at line 317 of file sampledMeshedSurface.H.
References MeshedSurface::surfFaces().
|
inlinevirtual |
Reimplemented from meshedSurf.
Definition at line 323 of file sampledMeshedSurface.H.
|
inlinevirtual |
Reimplemented from meshedSurf.
Definition at line 329 of file sampledMeshedSurface.H.
References MeshedSurface::faceIds().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 335 of file sampledMeshedSurface.H.
References MeshedSurface::Sf().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 341 of file sampledMeshedSurface.H.
References MeshedSurface::magSf().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 347 of file sampledMeshedSurface.H.
References MeshedSurface::Cf().
|
inlinevirtual |
Reimplemented from sampledSurface.
Definition at line 353 of file sampledMeshedSurface.H.
References MeshedSurface::faceIds().
|
inline |
Definition at line 359 of file sampledMeshedSurface.H.
References sampledMeshedSurface::boundaryFaces.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 680 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 689 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 698 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 707 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 716 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 725 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 734 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 742 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 751 of file sampledMeshedSurface.C.
|
virtual |
Implements sampledSurface.
Reimplemented in sampledMeshedSurfaceNormal.
Definition at line 760 of file sampledMeshedSurface.C.
|
virtual |
Reimplemented from sampledSurface.
Definition at line 768 of file sampledMeshedSurface.C.
References Foam::name(), os(), and points.
Foam::tmp<Foam::Field<Type> > sampleOnFaces | ( | const interpolation< Type > & | sampler | ) | const |
Definition at line 29 of file sampledMeshedSurfaceTemplates.C.
References forAll, mesh, Foam::New(), points, interpolation::psi(), range, Foam::HashTableOps::values(), and Foam::Zero.
Foam::tmp<Foam::Field<Type> > sampleOnPoints | ( | const interpolation< Type > & | interpolator | ) | const |
Definition at line 99 of file sampledMeshedSurfaceTemplates.C.
References forAll, interpolation::interpolate(), mesh, Foam::New(), interpolation::psi(), Foam::HashTableOps::values(), and Foam::Zero.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.