OpenFOAM logo
Open Source CFD Toolkit

surfaceFeatures Class Reference

Collaboration diagram for surfaceFeatures:

Collaboration graph
[legend]
List of all members.

Public Types

enum  edgeStatus { NONE, REGION, EXTERNAL, INTERNAL }

Public Member Functions

 ClassName ("surfaceFeatures")
 surfaceFeatures (const triSurface &)
 Construct from surface.
 surfaceFeatures (const triSurface &, const labelList &featurePoints, const labelList &featureEdges, const label externalStart, const label internalStart)
 Construct from components.
 surfaceFeatures (const triSurface &, const scalar includedAngle, const scalar minLen=0, const label minElems=0)
 Construct from surface, angle and min cumulative length and/or.
 surfaceFeatures (const triSurface &, const dictionary &dict)
 Construct from dictionary.
 surfaceFeatures (const triSurface &, const fileName &fName)
 Construct from file.
 surfaceFeatures (const surfaceFeatures &)
 Construct as copy.
const triSurfacesurface () const
const labelListfeaturePoints () const
 Return feature point list.
const labelListfeatureEdges () const
 Return feature edge list.
label externalStart () const
 start of external edges
label internalStart () const
 start of internal edges
label nRegionEdges () const
 Return number of region edges.
label nExternalEdges () const
 Return number of external edges.
label nInternalEdges () const
 Return number of internal edges.
void findFeatures (const scalar includedAngle)
 Find feature edges using provided included angle.
void trimFeatures (const scalar minLen, const label minElems)
 Delete small sets of edges. Edges are stringed up and any.
List< edgeStatustoStatus () const
 From member feature edges to status per edge.
void setFromStatus (const List< edgeStatus > &)
 Set from status per edge.
Map< labelnearestSamples (const labelList &pointLabels, const pointField &samples, const scalarField &maxDist) const
 Find nearest sample for every point (usually the set of.
Map< labelnearestSamplesToFeatEdges (const pointField &samples, const scalarField &sampleDist, const scalarField &maxDist, const scalar minSampleDist=0.1) const
 Find nearest sample for regularly sampled points along the.
Map< pointIndexHitnearestEdgesToFeatEdges (const edgeList &sampleEdges, const labelList &selectedSampleEdges, const pointField &samplePoints, const scalarField &sampleDist, const scalarField &maxDist, const scalar minSampleDist=0.1) const
 Like nearestSamplesToFeatEdges but now gets nearest point on.
void nearestSurfFeatures (const pointField &samples, const scalarField &maxDist, labelList &edgeLabel, labelList &edgeEndPoint, pointField &edgePoint) const
 Find nearest surface feature edge for each sample point.
void nearestSurfFeatures (const edgeList &sampleEdges, const labelList &selectedSampleEdges, const pointField &samplePoints, const vector &searchSpan, labelList &edgeLabel, pointField &pointOnEdge, pointField &pointOnFeature) const
 Find nearest surface feature edge for each sample edge.
void writeDict (Ostream &) const
 Write as dictionary.
void write (const fileName &fName) const
 Write as dictionary to file.
void writeObj (const fileName &prefix) const
 Write to separate OBJ files (region, external, internal edges,.
void operator= (const surfaceFeatures &)

Member Enumeration Documentation

enum edgeStatus
 

Enumeration values:
NONE 
REGION 
EXTERNAL 
INTERNAL 

Definition at line 80 of file surfaceFeatures.H.


Constructor & Destructor Documentation

surfaceFeatures const triSurface  ) 
 

Construct from surface.

surfaceFeatures const triSurface ,
const labelList featurePoints,
const labelList featureEdges,
const label  externalStart,
const label  internalStart
 

Construct from components.

surfaceFeatures const triSurface ,
const scalar  includedAngle,
const scalar  minLen = 0,
const label  minElems = 0
 

Construct from surface, angle and min cumulative length and/or.

number of elements

surfaceFeatures const triSurface ,
const dictionary dict
 

Construct from dictionary.

surfaceFeatures const triSurface ,
const fileName fName
 

Construct from file.

surfaceFeatures const surfaceFeatures  ) 
 

Construct as copy.


Member Function Documentation

ClassName "surfaceFeatures"   ) 
 

label externalStart  )  const [inline]
 

start of external edges

Definition at line 226 of file surfaceFeatures.H.

References Foam::label.

const labelList& featureEdges  )  const [inline]
 

Return feature edge list.

Definition at line 220 of file surfaceFeatures.H.

References Foam::label.

const labelList& featurePoints  )  const [inline]
 

Return feature point list.

Definition at line 214 of file surfaceFeatures.H.

References Foam::label.

void findFeatures const scalar  includedAngle  ) 
 

Find feature edges using provided included angle.

label internalStart  )  const [inline]
 

start of internal edges

Definition at line 232 of file surfaceFeatures.H.

References Foam::label.

Map<pointIndexHit> nearestEdgesToFeatEdges const edgeList sampleEdges,
const labelList selectedSampleEdges,
const pointField samplePoints,
const scalarField sampleDist,
const scalarField maxDist,
const scalar  minSampleDist = 0.1
const
 

Like nearestSamplesToFeatEdges but now gets nearest point on.

sample-edge instead of nearest sample-point itself. Return map from sample edge to feature edge.

Map<label> nearestSamples const labelList pointLabels,
const pointField samples,
const scalarField maxDist
const
 

Find nearest sample for every point (usually the set of.

featurePoints). Return map from index in samples to surface point. Do not include points that are further than maxDist away (separate maxDist for every sample)

Map<label> nearestSamplesToFeatEdges const pointField samples,
const scalarField sampleDist,
const scalarField maxDist,
const scalar  minSampleDist = 0.1
const
 

Find nearest sample for regularly sampled points along the.

feature edges. Return map from sample to feature edge. maxDist is distance below which gets snapped. Edge gets sampled at points sampleDist[sampleI] apart. (with a maximum of 10 samples per edge)

void nearestSurfFeatures const edgeList sampleEdges,
const labelList selectedSampleEdges,
const pointField samplePoints,
const vector searchSpan,
labelList edgeLabel,
pointField pointOnEdge,
pointField pointOnFeature
const
 

Find nearest surface feature edge for each sample edge.

Sets:

  • edgeLabel : label of surface edge.
  • pointOnEdge : exact position of nearest point on edge.
  • pointOnFeature : exact position on sample edge.

void nearestSurfFeatures const pointField samples,
const scalarField maxDist,
labelList edgeLabel,
labelList edgeEndPoint,
pointField edgePoint
const
 

Find nearest surface feature edge for each sample point.

Sets:

  • edgeLabel : label of surface edge.
  • edgePoint : exact position of nearest point on edge.
  • edgeEndPoint : -1, 0, 1 depending on whether edgePoint is on inside/start/end of edge

label nExternalEdges  )  const [inline]
 

Return number of external edges.

Definition at line 244 of file surfaceFeatures.H.

label nInternalEdges  )  const [inline]
 

Return number of internal edges.

Definition at line 250 of file surfaceFeatures.H.

References Foam::edgeList, Foam::labelList, Foam::pointField, Foam::scalarField, and Foam::vector.

label nRegionEdges  )  const [inline]
 

Return number of region edges.

Definition at line 238 of file surfaceFeatures.H.

References Foam::label.

void operator= const surfaceFeatures  ) 
 

void setFromStatus const List< edgeStatus > &   ) 
 

Set from status per edge.

const triSurface& surface  )  const [inline]
 

Definition at line 208 of file surfaceFeatures.H.

References Foam::labelList.

List<edgeStatus> toStatus  )  const
 

From member feature edges to status per edge.

void trimFeatures const scalar  minLen,
const label  minElems
 

Delete small sets of edges. Edges are stringed up and any.

string of length < minLen (or nElems < minElems) is deleted.

void write const fileName fName  )  const
 

Write as dictionary to file.

void writeDict Ostream  )  const
 

Write as dictionary.

void writeObj const fileName prefix  )  const
 

Write to separate OBJ files (region, external, internal edges,.

feature points) for visualization


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org