arcEdge Class Reference

An arcEdge between two points on a circle. The arc is defined either by a third point that the arc passes through, or by the angle of the sector and the axis of the circle. More...

Inheritance diagram for arcEdge:
Collaboration diagram for arcEdge:

Public Member Functions

 TypeName ("arc")
 Runtime type information. More...
 
 arcEdge (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &points, Istream &)
 Construct from Istream setting pointsList. More...
 
 arcEdge (const arcEdge &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~arcEdge ()
 Destructor. More...
 
point position (const scalar) const
 Return the point position corresponding to the curve parameter. More...
 
scalar length () const
 Return the length of the curve. More...
 
void operator= (const arcEdge &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from blockEdge
 TypeName ("blockEdge")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, blockEdge, Istream,(const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &points, Istream &is),(dict, index, geometry, points, is))
 
 blockEdge (const pointField &points, const label start, const label end)
 Construct from components. More...
 
 blockEdge (const dictionary &dict, const label index, const pointField &, Istream &)
 Construct from Istream setting pointsList. More...
 
virtual autoPtr< blockEdgeclone () const
 Clone function. More...
 
virtual ~blockEdge ()
 Destructor. More...
 
label start () const
 Return label of start point. More...
 
label end () const
 Return label of end point. More...
 
int compare (const blockEdge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const edge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const label start, const label end) const
 Compare the given start and end points with this curve. More...
 
virtual tmp< pointFieldposition (const scalarList &) const
 Return the point positions corresponding to the curve parameters. More...
 
void write (Ostream &, const dictionary &) const
 Write edge with variable backsubstitution. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from blockEdge
static autoPtr< blockEdgeNew (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &, Istream &)
 New function which constructs and returns pointer to a blockEdge. More...
 
- Static Protected Member Functions inherited from blockEdge
static pointField appendEndPoints (const pointField &, const label start, const label end, const pointField &otherKnots)
 Return a complete point field by appending the start/end points. More...
 
- Protected Attributes inherited from blockEdge
const pointFieldpoints_
 
const label start_
 
const label end_
 

Detailed Description

An arcEdge between two points on a circle. The arc is defined either by a third point that the arc passes through, or by the angle of the sector and the axis of the circle.

If the angle-axis specification is used, the axis may not be not perpendicular to the line connecting the end points. In that case, the axis is considered to be that of a cylinder, and the arc represents a portion of a helix on the surface of that cylinder.

Source files

Definition at line 57 of file arcEdge.H.

Constructor & Destructor Documentation

◆ arcEdge() [1/2]

arcEdge ( const dictionary dict,
const label  index,
const searchableSurfaces geometry,
const pointField points,
Istream is 
)

Construct from Istream setting pointsList.

Definition at line 104 of file arcEdge.C.

References token::BEGIN_LIST, Foam::degToRad(), Foam::normalised(), Istream::putBack(), and Foam::readScalar().

Here is the call graph for this function:

◆ arcEdge() [2/2]

arcEdge ( const arcEdge )
delete

Disallow default bitwise copy construction.

◆ ~arcEdge()

virtual ~arcEdge ( )
inlinevirtual

Destructor.

Definition at line 116 of file arcEdge.H.

Member Function Documentation

◆ TypeName()

TypeName ( "arc"  )

Runtime type information.

◆ position()

Foam::point position ( const scalar  lambda) const
virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements blockEdge.

Definition at line 140 of file arcEdge.C.

References Foam::abort(), Foam::cos(), Foam::FatalError, FatalErrorInFunction, lambda(), and Foam::sin().

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const
virtual

Return the length of the curve.

Implements blockEdge.

Definition at line 156 of file arcEdge.C.

References Foam::magSqr(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ operator=()

void operator= ( const arcEdge )
delete

Disallow default bitwise assignment.


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