Like Foam::uniformSet but samples patch edges. More...

Inheritance diagram for patchEdgeSet:

Collaboration diagram for patchEdgeSet:

Public Member Functions
	TypeName ("patchEdge")

	patchEdgeSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

virtual	~patchEdgeSet ()=default

Public Member Functions inherited from sampledSet
	TypeName ("sampledSet")

	declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict))

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const coordSet::coordFormat axisType)

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis)

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

autoPtr< sampledSet >	clone () const

virtual	~sampledSet ()=default

const polyMesh &	mesh () const

const meshSearch &	searchEngine () const

const labelList &	segments () const

const labelList &	cells () const

const labelList &	faces () const

Ostream &	write (Ostream &) const

autoPtr< coordSet >	gather (labelList &indexSet, labelList &allSegments) const

Public Member Functions inherited from coordSet
	coordSet (const word &name, const coordFormat axisType)

	coordSet (const word &name, const word &axis)

	coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)

	coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&curveDist)

const word &	name () const

word	axis () const

void	setPoints (const List< point > &newPoints)

void	setPoints (List< point > &&newPoints)

const scalarList &	curveDist () const

void	setCurveDist (const scalarList &curveDist)

void	setCurveDist (scalarList &&curveDist)

bool	hasVectorAxis () const

scalar	scalarCoord (const label index) const

vector	vectorCoord (const label index) const

Ostream &	write (Ostream &os) const

Public Member Functions inherited from Field
constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

	Field (const word &keyword, const dictionary &dict, const label len)

tmp< Field< Type > >	clone () const

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

void	autoMap (const FieldMapper &map, const bool applyFlip=true)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	negate ()

tmp< Field< cmptType > >	component (const direction) const

void	replace (const direction, const UList< cmptType > &)

void	replace (const direction, const tmp< Field< cmptType >> &)

void	replace (const direction, const cmptType &)

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const

void	writeEntry (const word &keyword, Ostream &os) const

SubField< Type >	slice (const label pos, label len=-1)

const SubField< Type >	slice (const label pos, label len=-1) const

SubField< Type >	slice (const labelRange &range)

const SubField< Type >	slice (const labelRange &range) const

void	operator= (const Field< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

template<class Type >
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const word &keyword, const dictionary &dict, const label len)

template<class Type >
void	operator= (const Field< Type > &rhs)

template<class Type >
void	operator= (const tmp< Field > &rhs)

template<class Type >
constexpr	Field () noexcept

template<class Type >
	Field (const label len)

template<class Type >
	Field (const label len, const Type &val)

template<class Type >
	Field (const label len, const Foam::zero)

template<class Type >
	Field (const Foam::one, const Type &val)

template<class Type >
	Field (const Foam::one, Type &&val)

template<class Type >
	Field (const Foam::one, const Foam::zero)

template<class Type >
	Field (const Field< Type > &fld)

template<class Type >
	Field (const UList< Type > &list)

template<class Type >
	Field (Field< Type > &&fld)

template<class Type >
	Field (List< Type > &&list)

template<class Type >
	Field (Field< Type > &fld, bool reuse)

template<class Type >
	Field (const tmp< Field< Type >> &tfld)

template<class Type >
	Field (Istream &is)

template<class Type >
void	operator= (const UList< Type > &rhs)

template<class Type >
void	operator= (const SubField< Type > &rhs)

template<class Type >
void	operator= (Field< Type > &&rhs)

template<class Type >
void	operator= (List< Type > &&rhs)

template<class Type >
void	operator= (const Type &val)

template<class Type >
void	operator= (const Foam::zero)

Additional Inherited Members
Public Types inherited from coordSet
enum	coordFormat { XYZ, X, Y, Z, DISTANCE }

Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType

typedef SubField< Type >	subField

Static Public Member Functions inherited from sampledSet
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

Static Public Member Functions inherited from Field
static const Field< Type > &	null ()

static autoPtr< Field< Type > >	New (Istream &is)

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

Static Public Attributes inherited from coordSet
static const Enum< coordFormat >	coordFormatNames

Protected Member Functions inherited from sampledSet
void	checkDimensions () const

label	getBoundaryCell (const label) const

label	getNeighbourCell (const label) const

label	pointInCell (const point &p, const label samplei) const

scalar	calcSign (const label facei, const point &sample) const

label	findNearFace (const label celli, const point &sample, const scalar smallDist) const

point	pushIn (const point &sample, const label facei) const

bool	getTrackingPoint (const point &samplePt, const point &bPoint, const label bFacei, const scalar smallDist, point &trackPt, label &trackCelli, label &trackFacei) const

void	setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)

void	setSamples (List< point > &&samplingPts, labelList &&samplingCells, labelList &&samplingFaces, labelList &&samplingSegments, scalarList &&samplingCurveDist)

Protected Attributes inherited from sampledSet
labelList	segments_

labelList	cells_

labelList	faces_

Protected Attributes inherited from coordSet
const word	name_

const coordFormat	axis_

scalarList	curveDist_

Detailed Description

Like Foam::uniformSet but samples patch edges.

Usage

Example of function object specification:

sets
{
    type                sets;
    libs                (sampling);
    writeControl        timeStep;
    writeInterval       1;

    fields              (p U);
    interpolationScheme cellPoint;
    setFormat           vtk;

    sets
    (
        // Intersections of patches with plane
        patchEdge
        {
            type        patchEdge;
            axis        x;

            // List of patches to sample (into single file). Note: supports
            // wildcards.
            patches     (movingWall);

            // Surface type
            surfaceType searchablePlane;
            // Additional info for surface
            planeType   pointAndNormal;
            pointAndNormalDict
            {
                point   (1.5 1.5 1.5);
                normal  (0.1 0 1);
            }

            // Sort point according to distance to origin
            origin      (0 1 0);
        }

        // Intersections of patches with stl
        sphere.stl
        {
            type        patchEdge;
            axis        x;

            patches     (movingWall);

            surfaceType triSurfaceMesh;
            // Sort point according to distance to origin
            origin      (0 1 0);
        }
    );
}

Where the entries comprise:

Property	Description	Required
`type`	patchEdge	yes
`axis`	x, y, z, xyz, distance	yes
`patches`	List of patch names or regexs	yes
`surfaceType`	Definition of the surface	yes
`origin`	reference location	yes

Note

The ordering of the points is according to the distance to the specified origin.
Collocated points get merged if closer than SMALL (1e-15 in double prec). (hardcoded). Collocated points can occur if patch points are exactly on the sampling plane. Note that (in parallel) any point merging gets done locally before sending to the master.

Source files

Definition at line 155 of file patchEdgeSet.H.

Constructor & Destructor Documentation

◆ patchEdgeSet()

patchEdgeSet	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const dictionary &	dict
	)

Definition at line 188 of file patchEdgeSet.C.

◆ ~patchEdgeSet()

virtual ~patchEdgeSet ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "patchEdge" )

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

src/sampling/sampledSet/patchEdge/patchEdgeSet.H
src/sampling/sampledSet/patchEdge/patchEdgeSet.C