Public Types | Public Member Functions | List of all members
sampledMeshedSurface Class Reference

A sampledSurface from a meshed surface. It samples on the points/faces of the meshed surface. More...

Inheritance diagram for sampledMeshedSurface:
Inheritance graph
[legend]
Collaboration diagram for sampledMeshedSurface:
Collaboration graph
[legend]

Public Types

enum  samplingSource : unsigned char { cells, insideCells, boundaryFaces }
 Types of sampling regions. More...
 
- Public Types inherited from MeshedSurface< face >
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...
 
- Public Types inherited from PrimitivePatch<::Foam::List< face >, pointField >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
 
typedef std::remove_reference< ::Foam::List< face > >::type::value_type face_type
 The face type. More...
 
typedef std::remove_reference< pointField >::type::value_type point_type
 The point type. More...
 
typedef ::Foam::List< faceFaceListType
 The face list type. More...
 
typedef pointField PointFieldType
 The point field type. More...
 
typedef face_type FaceType
 Deprecated(2020-03) prefer face_type typedef. More...
 
- Public Types inherited from List< face >
typedef SubList< facesubList
 Declare type of subList. More...
 
- Public Types inherited from UList< face >
typedef face value_type
 The value type the list contains. More...
 
typedef facepointer
 The pointer type for non-const access to value_type items. More...
 
typedef const faceconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef facereference
 The type used for storing into value_type objects. More...
 
typedef const faceconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef faceiterator
 Random access iterator for traversing a UList. More...
 
typedef const faceconst_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 

Public Member Functions

 TypeName ("sampledMeshedSurface")
 Declare type-name, virtual type (with debug switch) More...
 
 sampledMeshedSurface (const word &name, const polyMesh &mesh, const word &surfaceName, const samplingSource sampleSource)
 Construct from components. More...
 
 sampledMeshedSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~sampledMeshedSurface ()=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...
 
bool update (const treeBoundBox &bb)
 Update the surface using a bound box to limit the searching. More...
 
virtual const pointFieldpoints () const
 Points of surface. More...
 
virtual const faceListfaces () const
 Faces of surface. More...
 
virtual const labelListzoneIds () const
 Per-face zone/region information. More...
 
virtual const labelListfaceIds () const
 Per-face identifier (eg, element Id) More...
 
virtual const vectorFieldSf () const
 Face area vectors. More...
 
virtual const scalarFieldmagSf () const
 Face area magnitudes. More...
 
virtual const vectorFieldCf () const
 Face centres. More...
 
virtual bool hasFaceIds () const
 If element ids/order of the original surface are kept. More...
 
bool onBoundary () const
 Sampling boundary values instead of cell values. More...
 
virtual tmp< scalarFieldsample (const interpolation< scalar > &sampler) const
 Sample volume field onto surface faces. More...
 
virtual tmp< vectorFieldsample (const interpolation< vector > &sampler) const
 Sample volume field onto surface faces. More...
 
virtual tmp< sphericalTensorFieldsample (const interpolation< sphericalTensor > &sampler) const
 Sample volume field onto surface faces. More...
 
virtual tmp< symmTensorFieldsample (const interpolation< symmTensor > &sampler) const
 Sample volume field onto surface faces. More...
 
virtual tmp< tensorFieldsample (const interpolation< tensor > &sampler) const
 Sample volume field onto surface faces. More...
 
virtual tmp< scalarFieldinterpolate (const interpolation< scalar > &interpolator) const
 Interpolate volume field onto surface points. More...
 
virtual tmp< vectorFieldinterpolate (const interpolation< vector > &interpolator) const
 Interpolate volume field onto surface points. More...
 
virtual tmp< sphericalTensorFieldinterpolate (const interpolation< sphericalTensor > &interpolator) const
 Interpolate volume field onto surface points. More...
 
virtual tmp< symmTensorFieldinterpolate (const interpolation< symmTensor > &interpolator) const
 Interpolate volume field onto surface points. More...
 
virtual tmp< tensorFieldinterpolate (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
 
- Public Member Functions inherited from sampledSurface
 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< sampledSurfaceclone () const
 Clone. More...
 
virtual ~sampledSurface ()
 Destructor - calls clearGeom() More...
 
const polyMeshmesh () const noexcept
 Access to the underlying mesh. More...
 
const wordname () 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...
 
polySurfacegetRegistrySurface (const objectRegistry &obr, word lookupName="") const
 Get surface from registry if available. More...
 
polySurfacestoreRegistrySurface (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...
 
virtual bool withSurfaceFields () const
 Can it sample surface-fields? More...
 
virtual tmp< scalarFieldsample (const surfaceScalarField &sField) const
 Sample surface field onto surface. More...
 
virtual tmp< vectorFieldsample (const surfaceVectorField &sField) const
 Sample surface field onto surface. More...
 
virtual tmp< sphericalTensorFieldsample (const surfaceSphericalTensorField &sField) const
 Sample surface field onto surface. More...
 
virtual tmp< symmTensorFieldsample (const surfaceSymmTensorField &sField) const
 Sample surface field onto surface. More...
 
virtual tmp< tensorFieldsample (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::VolumeField< Type > > pointAverage (const PointField< Type > &pfld)
 
- Public Member Functions inherited from meshedSurf
constexpr meshedSurf () noexcept=default
 Default construct. More...
 
virtual ~meshedSurf ()=default
 Destructor. More...
 
- Public Member Functions inherited from MeshedSurface< face >
 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 labelListfaceIds () const
 Return const access to faces ids. More...
 
const surfZoneListsurfZones () const
 Const access to the surface zones. More...
 
const vectorFieldSf () const
 Face area vectors (normals) More...
 
const scalarFieldmagSf () const
 Face area magnitudes. More...
 
const vectorFieldCf () 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...
 
- Public Member Functions inherited from PrimitivePatch<::Foam::List< face >, pointField >
 PrimitivePatch (const ::Foam::List< face > &faces, const pointField &points)
 Construct from components. More...
 
 PrimitivePatch (::Foam::List< face > &&faces, const pointField &points)
 Construct from components, transferring faces. More...
 
 PrimitivePatch (::Foam::List< face > &faces, pointField &points, const bool reuse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< ::Foam::List< face >, pointField > &pp)
 Copy construct. More...
 
virtual ~PrimitivePatch ()
 Destructor. More...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
void swap (PrimitivePatch &)=delete
 Suppress direct swapping, since storage containers may be const. More...
 
const Field< point_type > & points () const noexcept
 Return reference to global points. More...
 
label nFaces () const noexcept
 Number of faces in the patch. More...
 
label nPoints () const
 Number of points supporting patch faces. More...
 
label nEdges () const
 Number of edges in patch. More...
 
const edgeListedges () const
 Return list of edges, address into LOCAL point list. More...
 
const edgeList::subList internalEdges () const
 Return sub-list of internal edges, address into LOCAL point list. More...
 
const edgeList::subList boundaryEdges () const
 Return sub-list of boundary edges, address into LOCAL point list. More...
 
label nInternalEdges () const
 Number of internal edges. More...
 
label nBoundaryEdges () const
 Number of boundary edges == (nEdges() - nInternalEdges()) More...
 
bool isInternalEdge (const label edgei) const
 Is internal edge? More...
 
const labelListboundaryPoints () const
 Return list of boundary points, address into LOCAL point list. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< face_type > & localFaces () const
 Return patch faces addressing into local point list. More...
 
labelList boundaryFaces () const
 Extract list of local faces corresponding to the boundary edges. More...
 
labelList uniqBoundaryFaces () const
 Extract sorted list of unique local faces associated with the boundary edges. More...
 
const labelListmeshPoints () const
 Return labelList of mesh points in patch. More...
 
const Map< label > & meshPointMap () const
 Mesh point map. More...
 
const Field< point_type > & localPoints () const
 Return pointField of points in patch. More...
 
const labelListlocalPointOrder () const
 Return orders the local points for most efficient search. More...
 
label whichPoint (const label gp) const
 Given a global point index, return the local point index. More...
 
edge meshEdge (const label edgei) const
 From patch edge to global edge using meshPoints. More...
 
edge meshEdge (const edge &e) const
 From patch edge to global edge using meshPoints. More...
 
label meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
 Return label of the local patch edge into the global edge list using basic edge addressing. More...
 
label findEdge (const edge &e) const
 Search for edge (local point labels) and return its index in the edge list or -1 if not found. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 Return labels of patch edges in the global edge list using cell addressing. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of patch edges into the global edge list using basic edge addressing. More...
 
labelList meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of specified patch edges into the global edge list using basic edge addressing. More...
 
const Field< point_type > & faceCentres () const
 Return face centres for patch. More...
 
const Field< point_type > & faceAreas () const
 Return face area vectors for patch. More...
 
const Field< scalar > & magFaceAreas () const
 Return face area magnitudes for patch. More...
 
const Field< point_type > & faceNormals () const
 Return face unit normals for patch. More...
 
const Field< point_type > & pointNormals () const
 Return point normals for patch. More...
 
Pair< point_typebox () const
 The enclosing (bounding) box for the patch points. More...
 
scalar sphere (const label facei) const
 The enclosing (bounding) sphere radius^2 for specified face. More...
 
bool hasFaceAreas () const
 
bool hasFaceCentres () const
 
bool hasFaceNormals () const
 
bool hasPointNormals () const
 
bool hasBoundaryPoints () const
 
bool hasEdges () const
 
bool hasFaceFaces () const
 
bool hasEdgeFaces () const
 
bool hasFaceEdges () const
 
bool hasPointEdges () const
 
bool hasPointFaces () const
 
bool hasMeshPoints () const
 
bool hasMeshPointMap () const
 
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
const labelListListedgeLoops () const
 Return list of closed loops of boundary vertices. More...
 
surfaceTopo surfaceType (labelHashSet *badEdgesPtr=nullptr) const
 Calculate surface type formed by patch, optionally recording the indices of illegal edges. More...
 
bool checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< point_type > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< ::Foam::List< face >, pointField > &rhs)
 Copy assign faces. Leave points alone (could be a reference). More...
 
void operator= (PrimitivePatch< ::Foam::List< face >, pointField > &&rhs)
 Move assign faces. Leave points alone (could be a reference). More...
 
label whichEdge (const edge &e) const
 Identical to findEdge. More...
 
- Public Member Functions inherited from PrimitivePatchBase
 ClassName ("PrimitivePatch")
 Runtime type information. More...
 
 PrimitivePatchBase ()=default
 Default construct. More...
 
- Public Member Functions inherited from List< face >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const face &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const face &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, face &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< face > &a)
 Copy construct from list. More...
 
 List (const UList< face > &a)
 Copy construct contents from list. More...
 
 List (List< face > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< face > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< face > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< face, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< face > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< face > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< face, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< face > list)
 Construct from an initializer list. More...
 
 List (List< face > &&list)
 Move construct from List. More...
 
 List (DynamicList< face, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< face > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< face > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const face &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const face &val)
 Alias for resize() More...
 
void transfer (List< face > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< face, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
facenewElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
faceemplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element. More...
 
void push_back (const face &val)
 Append an element at the end of the list. More...
 
void push_back (face &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< face > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< face, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const face &val)
 Append an element if not already in the list. More...
 
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list. More...
 
void operator= (const UList< face > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< face > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< face > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< face, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< face, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< face > list)
 Assignment to an initializer list. More...
 
void operator= (const face &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< face > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< face, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< face > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 Specialized list reading for character lists which always uses binary format. More...
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< face > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 
void append (const face &val)
 Append an element at the end of the list. More...
 
void append (face &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< face > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< face, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const face &val)
 Append an element if not already in the list. More...
 
- Public Member Functions inherited from UList< face >
label size () const noexcept
 The number of elements in the List. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
void operator= (const face &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
 UList (const UList< face > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (face *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 The forward circular index. The next index in the list which returns to the first at the end of the list. More...
 
label rcIndex (const label i) const noexcept
 The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
 
const facefcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
facefcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const facercValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
facercValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const facecdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
facedata () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
facefront ()
 Access first element of the list, position [0]. More...
 
const facefront () const
 Access first element of the list. More...
 
faceback ()
 Access last element of the list, position [size()-1]. More...
 
const faceback () const
 Access last element of the list, position [size()-1]. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
label find (const face &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const face &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool contains (const face &val, label pos=0) const
 Is the value contained in the list? More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (const UList< face > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< face > &list)
 Copy elements of the given UList. Sizes must match! More...
 
void deepCopy (const IndirectListBase< face, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< faceslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< faceslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< faceslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< faceslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
faceoperator[] (const label i)
 Return element of UList. More...
 
const faceoperator[] (const label i) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
 operator const Foam::List< face > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
void swap (UList< face > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< face > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< face > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< face > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< face > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< face > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< face > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
IstreamreadList (Istream &is)
 Specialized list reading for character lists which always uses binary format. More...
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
OstreamwriteList (Ostream &os, const label) const
 Specialized writeList for character lists which always uses binary format. More...
 
OstreamwriteList (Ostream &os, const label) const
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 Test bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 Return bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access. More...
 
facefirst ()
 Access first element of the list, position [0]. More...
 
const facefirst () const
 Access first element of the list. More...
 
facelast ()
 Access last element of the list, position [size()-1]. More...
 
const facelast () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const face &val, label pos=0) const
 Same as contains() More...
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()=default
 Default construct. More...
 
virtual ~surfaceFormatsCore ()=default
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurfaceNew (const word &name, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected surface. More...
 
- Static Public Member Functions inherited from MeshedSurface< face >
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< MeshedSurfaceNew (const fileName &name, const word &fileType, bool mandatory=true)
 Read construct from filename with given file type. More...
 
static autoPtr< MeshedSurfaceNew (const fileName &name)
 Read construct from filename (file type implicit from extension) More...
 
- Static Public Member Functions inherited from List< face >
static const List< face > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< face >
static const UList< face > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Member Functions inherited from surfaceFormatsCore
static bool checkSupport (const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr)
 Verbose checking of fileType in the list of available types. More...
 
static fileName findFile (const IOobject &io, const bool isGlobal=true)
 Use IOobject information to resolve file to load from, or empty if the file does not exist. More...
 
static fileName findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 Use IOobject information to resolve file to load from, or empty if the file does not exist. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Protected Member Functions inherited from sampledSurface
virtual void clearGeom () const
 Additional cleanup when clearing the geometry. More...
 
 sampledSurface (const word &name, std::nullptr_t)
 Construct null. More...
 
- Protected Member Functions inherited from MeshedSurface< face >
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...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< face > & storedFaces ()
 Non-const access to the faces. More...
 
labelListstoredFaceIds ()
 Non-const access to face ids. More...
 
surfZoneListstoredZones ()
 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...
 
- Protected Member Functions inherited from UList< face >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
void writeEntry (Ostream &os) const
 Specialized writeEntry for character lists which always uses binary format. More...
 
void writeEntry (Ostream &os) const
 
labelRange validateRange (const labelRange &requestedRange) const
 Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...
 
UList< face > & operator= (const UList< face > &)=delete
 No copy assignment (default: shallow copy) More...
 
- Static Protected Member Functions inherited from sampledSurface
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< VolumeField< Type > > pointAverage (const PointField< Type > &pfld)
 Create cell values by averaging the point values. More...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
static string getLineNoComment (ISstream &is, const char comment='#')
 Read non-empty and non-comment line. More...
 
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 Return a surfZone list with a single entry, the size of which corresponds to that of the container. More...
 
static labelList getSelectedPatches (const surfZoneList &patches, const wordRes &allow, const wordRes &deny=wordRes())
 Return ids for zone/patch that match by name. More...
 
static fileName relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true)
 Return fileName. More...
 
static fileName checkFile (const IOobject &io, const bool isGlobal=true)
 Return fileName to load IOobject from. More...
 
static fileName checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 Return fileName to load IOobject from. More...
 

Detailed Description

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.

Usage
Example of function object partial specification:
surfaces
{
    surface1
    {
        type    meshedSurface;
        surface something.obj;
        source  cells;

        /*!
         * \brief Max sampling distance
*/
            maxDistance 0.005;

            /*!
             * \brief 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

SourceFiles sampledMeshedSurface.C sampledMeshedSurfaceTemplates.C

\*—————————————————————————

Definition at line 186 of file sampledMeshedSurface.H.

Member Enumeration Documentation

◆ samplingSource

enum samplingSource : unsigned char
strong

Types of sampling regions.

Enumerator
cells 

Use nearest cell value.

insideCells 

Surface face within a cell, or trim.

boundaryFaces 

Use nearest boundary face values.

Definition at line 196 of file sampledMeshedSurface.H.

Constructor & Destructor Documentation

◆ sampledMeshedSurface() [1/2]

sampledMeshedSurface ( const word name,
const polyMesh mesh,
const word surfaceName,
const samplingSource  sampleSource 
)

Construct from components.

Definition at line 464 of file sampledMeshedSurface.C.

◆ sampledMeshedSurface() [2/2]

sampledMeshedSurface ( const word name,
const polyMesh mesh,
const dictionary dict 
)

◆ ~sampledMeshedSurface()

virtual ~sampledMeshedSurface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sampledMeshedSurface"  )

Declare type-name, virtual type (with debug switch)

◆ needsUpdate()

bool needsUpdate ( ) const
virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 598 of file sampledMeshedSurface.C.

◆ expire()

bool expire ( )
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 604 of file sampledMeshedSurface.C.

References MeshedSurface< face >::clear(), and sampledSurface::clearGeom().

Here is the call graph for this function:

◆ update() [1/2]

bool update ( )
virtual

Update the surface as required.

Do nothing (and return false) if no update was needed

Implements sampledSurface.

Definition at line 624 of file sampledMeshedSurface.C.

References polyMesh::bounds(), Foam::constant::electromagnetic::e, Foam::endl(), polyMesh::FACE_PLANES, boundBox::grow(), mesh, update(), and WarningInFunction.

Here is the call graph for this function:

◆ update() [2/2]

bool update ( const treeBoundBox bb)

Update the surface using a bound box to limit the searching.

For direct use, i.e. not through sample. Do nothing (and return false) if no update was needed

Definition at line 664 of file sampledMeshedSurface.C.

References polyMesh::FACE_PLANES, mesh, and update().

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const
inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 364 of file sampledMeshedSurface.H.

◆ faces()

virtual const faceList& faces ( ) const
inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 372 of file sampledMeshedSurface.H.

◆ zoneIds()

virtual const labelList& zoneIds ( ) const
inlinevirtual

Per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 380 of file sampledMeshedSurface.H.

◆ faceIds()

virtual const labelList& faceIds ( ) const
inlinevirtual

Per-face identifier (eg, element Id)

Reimplemented from meshedSurf.

Definition at line 388 of file sampledMeshedSurface.H.

◆ Sf()

virtual const vectorField& Sf ( ) const
inlinevirtual

Face area vectors.

Implements sampledSurface.

Definition at line 396 of file sampledMeshedSurface.H.

◆ magSf()

virtual const scalarField& magSf ( ) const
inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 404 of file sampledMeshedSurface.H.

◆ Cf()

virtual const vectorField& Cf ( ) const
inlinevirtual

Face centres.

Implements sampledSurface.

Definition at line 412 of file sampledMeshedSurface.H.

◆ hasFaceIds()

virtual bool hasFaceIds ( ) const
inlinevirtual

If element ids/order of the original surface are kept.

Reimplemented from sampledSurface.

Definition at line 420 of file sampledMeshedSurface.H.

◆ onBoundary()

bool onBoundary ( ) const
inline

Sampling boundary values instead of cell values.

Definition at line 428 of file sampledMeshedSurface.H.

◆ sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const interpolation< scalar > &  sampler) const
virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 679 of file sampledMeshedSurface.C.

◆ sample() [2/5]

Foam::tmp< Foam::vectorField > sample ( const interpolation< vector > &  sampler) const
virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 688 of file sampledMeshedSurface.C.

◆ sample() [3/5]

Foam::tmp< Foam::sphericalTensorField > sample ( const interpolation< sphericalTensor > &  sampler) const
virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 697 of file sampledMeshedSurface.C.

◆ sample() [4/5]

Foam::tmp< Foam::symmTensorField > sample ( const interpolation< symmTensor > &  sampler) const
virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 706 of file sampledMeshedSurface.C.

◆ sample() [5/5]

Foam::tmp< Foam::tensorField > sample ( const interpolation< tensor > &  sampler) const
virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 715 of file sampledMeshedSurface.C.

◆ interpolate() [1/5]

Foam::tmp< Foam::scalarField > interpolate ( const interpolation< scalar > &  interpolator) const
virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 724 of file sampledMeshedSurface.C.

◆ interpolate() [2/5]

Foam::tmp< Foam::vectorField > interpolate ( const interpolation< vector > &  interpolator) const
virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 733 of file sampledMeshedSurface.C.

◆ interpolate() [3/5]

Foam::tmp< Foam::sphericalTensorField > interpolate ( const interpolation< sphericalTensor > &  interpolator) const
virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 741 of file sampledMeshedSurface.C.

◆ interpolate() [4/5]

Foam::tmp< Foam::symmTensorField > interpolate ( const interpolation< symmTensor > &  interpolator) const
virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 750 of file sampledMeshedSurface.C.

◆ interpolate() [5/5]

Foam::tmp< Foam::tensorField > interpolate ( const interpolation< tensor > &  interpolator) const
virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledMeshedSurfaceNormal.

Definition at line 759 of file sampledMeshedSurface.C.

◆ print()

void print ( Ostream os,
int  level = 0 
) const
virtual

Print information.

Reimplemented from sampledSurface.

Definition at line 767 of file sampledMeshedSurface.C.

References Foam::name(), os(), points, and UList< T >::size().

Here is the call graph for this function:

◆ sampleOnFaces()

Foam::tmp<Foam::Field<Type> > sampleOnFaces ( const interpolation< Type > &  sampler) const

Definition at line 29 of file sampledMeshedSurfaceTemplates.C.

References forAll, mesh, Foam::New(), pbm, points, interpolation< Type >::psi(), UList< T >::size(), Foam::HashTableOps::values(), and Foam::Zero.

Here is the call graph for this function:

◆ sampleOnPoints()

Foam::tmp<Foam::Field<Type> > sampleOnPoints ( const interpolation< Type > &  interpolator) const

The documentation for this class was generated from the following files: