wallPoints Class Reference

For use with FaceCellWave. Determines topological distance to starting faces. More...

Collaboration diagram for wallPoints:
[legend]

Classes

class  trackData
 Class used to pass additional data in. More...
 

Public Member Functions

 wallPoints ()
 Default construct. More...
 
 wallPoints (const UList< point > &origin, const UList< scalar > &distSqr, const UList< FixedList< label, 3 >> &surface)
 Construct from count. More...
 
const List< point > & origin () const
 
const List< scalar > & distSqr () const
 
const List< FixedList< label, 3 > > & surface () const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const polyMesh &, const wallPoints &, const scalar, TrackingData &td) const
 Check for identical geometrical data (eg, cyclics checking) More...
 
template<class TrackingData >
void leaveDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Convert any absolute coordinates into relative to (patch)face. More...
 
template<class TrackingData >
void enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Reverse of leaveDomain. More...
 
template<class TrackingData >
void transform (const polyMesh &, const tensor &, TrackingData &td)
 Apply rotation matrix to any coordinates. More...
 
template<class TrackingData >
bool updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const wallPoints &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const wallPoints &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const wallPoints &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const wallPoints &, TrackingData &) const
 Test for equality, with TrackingData. More...
 
bool operator== (const wallPoints &) const
 Test for equality. More...
 
bool operator!= (const wallPoints &) const
 Test for inequality. More...
 

Protected Member Functions

template<class TrackingData >
bool update (const point &pt, const label index1, const wallPoints &w2, const label index2, const scalar tol, TrackingData &td)
 Originating normal. More...
 

Protected Attributes

DynamicList< pointorigin_
 Starting points. More...
 
DynamicList< scalar > distSqr_
 Distance (squared) from cellcenter to origin. More...
 
DynamicList< FixedList< label, 3 > > surface_
 Originating surface,region and topological region. More...
 

Friends

Ostreamoperator<< (Ostream &, const wallPoints &)
 
Istreamoperator>> (Istream &, wallPoints &)
 

Detailed Description

For use with FaceCellWave. Determines topological distance to starting faces.

Source files

Definition at line 62 of file wallPoints.H.

Constructor & Destructor Documentation

◆ wallPoints() [1/2]

wallPoints ( )
inline

Default construct.

Definition at line 90 of file wallPointsI.H.

◆ wallPoints() [2/2]

wallPoints ( const UList< point > &  origin,
const UList< scalar > &  distSqr,
const UList< FixedList< label, 3 >> &  surface 
)
inline

Construct from count.

Definition at line 100 of file wallPointsI.H.

Member Function Documentation

◆ update()

bool update ( const point pt,
const label  index1,
const wallPoints w2,
const label  index2,
const scalar  tol,
TrackingData &  td 
)
inlineprotected

Originating normal.

DynamicList<vector> normal_; Evaluate distance to point.

Update distSqr, origin from whomever is nearer pt.

Returns
true if w2 is closer to point, false otherwise.

Definition at line 35 of file wallPointsI.H.

References Foam::diff(), Foam::magSqr(), and w2.

Here is the call graph for this function:

◆ origin()

const List<point>& origin ( ) const
inline

Definition at line 137 of file wallPoints.H.

References wallPoints::origin_.

◆ distSqr()

const List<scalar>& distSqr ( ) const
inline

Definition at line 141 of file wallPoints.H.

References wallPoints::distSqr_.

◆ surface()

const List<FixedList<label, 3> >& surface ( ) const
inline

Definition at line 146 of file wallPoints.H.

References wallPoints::surface_.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 117 of file wallPointsI.H.

◆ sameGeometry()

bool sameGeometry ( const polyMesh ,
const wallPoints ,
const  scalar,
TrackingData &  td 
) const
inline

Check for identical geometrical data (eg, cyclics checking)

Definition at line 126 of file wallPointsI.H.

◆ leaveDomain()

void leaveDomain ( const polyMesh ,
const polyPatch patch,
const label  patchFacei,
const point faceCentre,
TrackingData &  td 
)
inline

Convert any absolute coordinates into relative to (patch)face.

centre

Definition at line 140 of file wallPointsI.H.

◆ enterDomain()

void enterDomain ( const polyMesh ,
const polyPatch patch,
const label  patchFacei,
const point faceCentre,
TrackingData &  td 
)
inline

Reverse of leaveDomain.

Definition at line 174 of file wallPointsI.H.

◆ transform()

void transform ( const polyMesh ,
const tensor rotTensor,
TrackingData &  td 
)
inline

Apply rotation matrix to any coordinates.

Definition at line 158 of file wallPointsI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updateCell()

bool updateCell ( const polyMesh mesh,
const label  thisCelli,
const label  neighbourFacei,
const wallPoints neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 193 of file wallPointsI.H.

References primitiveMesh::cellCentres(), forAll, Foam::magSqr(), mesh, wallPoints::origin_, wallPoints::surface_, and update().

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const label  neighbourCelli,
const wallPoints neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 235 of file wallPointsI.H.

References primitiveMesh::faceCentres(), forAll, Foam::magSqr(), mesh, wallPoints::origin_, wallPoints::surface_, and update().

Here is the call graph for this function:

◆ updateFace() [2/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const wallPoints neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 282 of file wallPointsI.H.

References primitiveMesh::faceCentres(), forAll, Foam::magSqr(), mesh, wallPoints::origin_, wallPoints::surface_, and update().

Here is the call graph for this function:

◆ equal()

bool equal ( const wallPoints rhs,
TrackingData &  td 
) const
inline

Test for equality, with TrackingData.

Definition at line 327 of file wallPointsI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const wallPoints rhs) const
inline

Test for equality.

Definition at line 339 of file wallPointsI.H.

References wallPoints::distSqr_, wallPoints::origin_, and wallPoints::surface_.

◆ operator!=()

bool operator!= ( const wallPoints rhs) const
inline

Test for inequality.

Definition at line 352 of file wallPointsI.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const wallPoints  
)
friend

◆ operator>>

Istream& operator>> ( Istream ,
wallPoints  
)
friend

Member Data Documentation

◆ origin_

DynamicList<point> origin_
protected

Starting points.

Definition at line 86 of file wallPoints.H.

Referenced by wallPoints::operator==(), wallPoints::origin(), wallPoints::updateCell(), and wallPoints::updateFace().

◆ distSqr_

DynamicList<scalar> distSqr_
protected

Distance (squared) from cellcenter to origin.

Definition at line 89 of file wallPoints.H.

Referenced by wallPoints::distSqr(), and wallPoints::operator==().

◆ surface_

DynamicList<FixedList<label, 3> > surface_
protected

Originating surface,region and topological region.

Definition at line 92 of file wallPoints.H.

Referenced by wallPoints::operator==(), wallPoints::surface(), wallPoints::updateCell(), and wallPoints::updateFace().


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