location Class Reference
Inheritance diagram for location:
Collaboration diagram for location:

Public Member Functions

 location ()
 Construct null. More...
 
bool isNull () const
 Return whether the location is null. More...
 
bool isSrcPoint () const
 Return whether the location is a source point. More...
 
bool isTgtPoint () const
 Return whether the location is a target point. More...
 
bool isSrcNotTgtPoint () const
 Return whether the location is a source point and not a target. More...
 
bool isTgtNotSrcPoint () const
 Return whether the location is a target point and not a source. More...
 
bool isSrcAndTgtPoint () const
 Return whether the location is a source point and a target point. More...
 
bool isIntersection () const
 Return whether the location is an intersection. More...
 
label srcPointi () const
 Return the source point index. More...
 
label tgtPointi () const
 Return the target point index. More...
 
label srcEdgei () const
 Return the source edge index. More...
 
label tgtEdgei () const
 Return the target edge index. More...
 

Static Public Member Functions

static location srcPoint (const label srcPi)
 Construct a source point location. More...
 
static location tgtPoint (const label tgtPi)
 Construct a target point location. More...
 
static location srcTgtPoint (const label srcPi, const label tgtPi)
 Construct a source and target point location. More...
 
static location intersection (const label srcEi, const label tgtEi)
 Construct an intersection location between a source and a. More...
 

Friends

bool operator== (const location &a, const location &b)
 Test if locations are the same. More...
 
bool operator!= (const location &a, const location &b)
 Test if locations are not the same. More...
 
Ostreamoperator<< (Ostream &os, const location &l)
 Output the location to a stream. More...
 

Detailed Description

Definition at line 59 of file triIntersectLocation.H.

Constructor & Destructor Documentation

◆ location()

location ( )
inline

Construct null.

Definition at line 80 of file triIntersectLocationI.H.

Member Function Documentation

◆ srcPoint()

Foam::triIntersect::location srcPoint ( const label  srcPi)
inlinestatic

Construct a source point location.

Definition at line 51 of file triIntersectLocationI.H.

Referenced by Foam::triIntersect::intersectTris().

Here is the caller graph for this function:

◆ tgtPoint()

Foam::triIntersect::location tgtPoint ( const label  tgtPi)
inlinestatic

Construct a target point location.

Definition at line 58 of file triIntersectLocationI.H.

Referenced by Foam::triIntersect::intersectTris().

Here is the caller graph for this function:

◆ srcTgtPoint()

Foam::triIntersect::location srcTgtPoint ( const label  srcPi,
const label  tgtPi 
)
inlinestatic

Construct a source and target point location.

Definition at line 65 of file triIntersectLocationI.H.

Referenced by Foam::triIntersect::intersectTris().

Here is the caller graph for this function:

◆ intersection()

Foam::triIntersect::location intersection ( const label  srcEi,
const label  tgtEi 
)
inlinestatic

Construct an intersection location between a source and a.

target edge

Definition at line 72 of file triIntersectLocationI.H.

Referenced by Foam::triIntersect::intersectTris().

Here is the caller graph for this function:

◆ isNull()

bool isNull ( ) const
inline

Return whether the location is null.

Definition at line 88 of file triIntersectLocationI.H.

References Pair< Type >::first(), and Pair< Type >::second().

Here is the call graph for this function:

◆ isSrcPoint()

bool isSrcPoint ( ) const
inline

Return whether the location is a source point.

Definition at line 94 of file triIntersectLocationI.H.

References Pair< Type >::first().

Referenced by Foam::triIntersect::generateGeometryForLocations(), location::isSrcAndTgtPoint(), location::isSrcNotTgtPoint(), location::isTgtNotSrcPoint(), Foam::triIntersect::orderLocations(), intersection::srcBoxStatic(), and location::srcPointi().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isTgtPoint()

bool isTgtPoint ( ) const
inline

Return whether the location is a target point.

Definition at line 100 of file triIntersectLocationI.H.

References Pair< Type >::second().

Referenced by Foam::triIntersect::generateGeometryForLocations(), location::isSrcAndTgtPoint(), location::isSrcNotTgtPoint(), location::isTgtNotSrcPoint(), Foam::triIntersect::orderLocations(), intersection::srcBoxStatic(), and location::tgtPointi().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isSrcNotTgtPoint()

bool isSrcNotTgtPoint ( ) const
inline

Return whether the location is a source point and not a target.

point

Definition at line 106 of file triIntersectLocationI.H.

References location::isSrcPoint(), and location::isTgtPoint().

Referenced by Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isTgtNotSrcPoint()

bool isTgtNotSrcPoint ( ) const
inline

Return whether the location is a target point and not a source.

point

Definition at line 112 of file triIntersectLocationI.H.

References location::isSrcPoint(), and location::isTgtPoint().

Referenced by Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isSrcAndTgtPoint()

bool isSrcAndTgtPoint ( ) const
inline

Return whether the location is a source point and a target point.

Definition at line 118 of file triIntersectLocationI.H.

References location::isSrcPoint(), and location::isTgtPoint().

Referenced by Foam::triIntersect::generateGeometryForLocations(), Foam::triIntersect::intersectTris(), and Foam::triIntersect::orderLocations().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isIntersection()

bool isIntersection ( ) const
inline

Return whether the location is an intersection.

Definition at line 124 of file triIntersectLocationI.H.

References Pair< Type >::first(), and Pair< Type >::second().

Referenced by Foam::triIntersect::intersectTris(), Foam::triIntersect::orderLocations(), intersection::srcBoxStatic(), location::srcEdgei(), and location::tgtEdgei().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ srcPointi()

Foam::label srcPointi ( ) const
inline

Return the source point index.

Definition at line 132 of file triIntersectLocationI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Pair< Type >::first(), and location::isSrcPoint().

Referenced by Foam::triIntersect::generateGeometryForLocations(), Foam::triIntersect::intersectTris(), Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tgtPointi()

Foam::label tgtPointi ( ) const
inline

Return the target point index.

Definition at line 146 of file triIntersectLocationI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, location::isTgtPoint(), and Pair< Type >::second().

Referenced by Foam::triIntersect::generateGeometryForLocations(), Foam::triIntersect::intersectTris(), Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ srcEdgei()

Foam::label srcEdgei ( ) const
inline

Return the source edge index.

Definition at line 160 of file triIntersectLocationI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Pair< Type >::first(), and location::isIntersection().

Referenced by Foam::triIntersect::generateGeometryForLocations(), Foam::triIntersect::intersectTris(), Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tgtEdgei()

Foam::label tgtEdgei ( ) const
inline

Return the target edge index.

Definition at line 174 of file triIntersectLocationI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, location::isIntersection(), and Pair< Type >::second().

Referenced by Foam::triIntersect::generateGeometryForLocations(), Foam::triIntersect::intersectTris(), Foam::triIntersect::orderLocations(), and intersection::srcBoxStatic().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator== ( const location a,
const location b 
)
friend

Test if locations are the same.

◆ operator!=

bool operator!= ( const location a,
const location b 
)
friend

Test if locations are not the same.

◆ operator<<

Ostream& operator<< ( Ostream os,
const location l 
)
friend

Output the location to a stream.


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