A blockEdge defined as an arc of a circle. More...

#include <arcEdge.H>

Inheritance diagram for arcEdge:

Collaboration diagram for arcEdge:

Public Member Functions
	TypeName ("arc")
	Runtime type information.
	arcEdge (const pointField &points, const point &origin, const edge &fromTo)
	Construct from components, given the origin of the circle.
	arcEdge (const pointField &points, const edge &fromTo, const point &midPoint)
	Construct from components, using a point on the circumference.
	arcEdge (const pointField &points, const point &origin, const label from, const label to)
	Construct from components, given the origin of the circle.
	arcEdge (const pointField &points, const label from, const label to, const point &midPoint)
	Construct from components, using a point on the circumference.
	arcEdge (const dictionary &dict, const label index, const searchableSurfaces &, const pointField &points, Istream &is)
	Construct from Istream and point field.
virtual	~arcEdge ()=default
	Destructor.
point	position (const scalar lambda) const
	The point corresponding to the curve parameter [0-1].
scalar	length () const noexcept
	The length of the curve.
Public Member Functions inherited from blockEdge
	TypeName ("blockEdge")
	Runtime type information.
	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 edge &fromTo)
	Construct from components.
	blockEdge (const dictionary &dict, const label index, const pointField &points, Istream &is)
	Construct from Istream and point field.
virtual autoPtr< blockEdge >	clone () const
	Clone function.
virtual	~blockEdge ()=default
	Destructor.
bool	good () const noexcept
	True if first/last indices are unique and non-negative.
bool	valid () const noexcept
	Same as good().
label	start () const noexcept
	Index of start (first) point.
label	end () const noexcept
	Index of end (last) point.
const point &	firstPoint () const
	The location of the first point.
const point &	lastPoint () const
	The location of the last point.
int	compare (const blockEdge &e) const
	Compare the given start/end points with this block edge.
int	compare (const edge &e) const
	Compare the given start/end points with this block edge.
int	compare (const label start, const label end) const
	Compare the given start/end points with this block edge.
point	linearPosition (const scalar lambda) const
	The point position in the straight line.
virtual tmp< pointField >	position (const scalarList &lambdas) const
	The point positions corresponding to the curve parameters.
void	write (Ostream &os, const dictionary &dict) const
	Write edge with variable back-substitution.

Additional Inherited Members
Static Public Member Functions inherited from blockEdge
static autoPtr< blockEdge >	New (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &points, Istream &is)
	New function which constructs and returns pointer to a blockEdge.
Protected Member Functions inherited from blockEdge
	blockEdge (const pointField &points, const label from, const label to)
	Construct from components.
Static Protected Member Functions inherited from blockEdge
static pointField	appendEndPoints (const pointField &p, const label from, const label to, const pointField &intermediate)
	Return a complete point field by appending the start/end points to the given list.
Protected Attributes inherited from blockEdge
const pointField &	points_
	The referenced point field.
const label	start_
	Index of the first point.
const label	end_
	Index of the last point.

Detailed Description

A blockEdge defined as an arc of a circle.

The arc is normally defined by its endpoints and a point on its circumference, typically a midpoint. For example,

points ((1 0 0) (0 1 0));

arc 0 1 (0.707107 0.707107 0);

The arc can enclose an angle greater than 0 and less than 360 degrees.

The arc will frequently enclose an angle less than 180 degrees. For the case, it is possible to define the arc by its endpoints and its centre (origin) point. For example,

arc 0 1 origin (0 0 0);

When defined in the way, any discrepancy in the arc radius for the endpoints is resolved by adjusting the origin to ensure that the average radius is satisfied.

It is also possible to define a flatness factor as a multiplier of the calculated radius. For example,

arc 0 1 origin 1.1 (0 0 0);

Source files

Definition at line 75 of file arcEdge.H.

Constructor & Destructor Documentation

◆ arcEdge() [1/5]

arcEdge	(	const pointField &	points,
		const point &	origin,
		const edge &	fromTo )

Construct from components, given the origin of the circle.

Parameters

points	Referenced point field
origin	The origin of the circle
fromTo	Start/end in point field

Definition at line 185 of file arcEdge.C.

References blockEdge::blockEdge(), blockEdge::firstPoint(), blockEdge::lastPoint(), and points.

Here is the call graph for this function:

◆ arcEdge() [2/5]

arcEdge	(	const pointField &	points,
		const edge &	fromTo,
		const point &	midPoint )

Construct from components, using a point on the circumference.

Parameters

points	Referenced point field
fromTo	Start/end in point field
midPoint	A point on the circumference

Definition at line 201 of file arcEdge.C.

References blockEdge::blockEdge(), blockEdge::firstPoint(), blockEdge::lastPoint(), and points.

Here is the call graph for this function:

◆ arcEdge() [3/5]

arcEdge	(	const pointField &	points,
		const point &	origin,
		const label	from,
		const label	to )

Construct from components, given the origin of the circle.

Parameters

points	Referenced point field
origin	The origin of the circle
from	Start point in point field
to	End point in point field

Definition at line 217 of file arcEdge.C.

References points.

◆ arcEdge() [4/5]

arcEdge	(	const pointField &	points,
		const label	from,
		const label	to,
		const point &	midPoint )

Construct from components, using a point on the circumference.

Parameters

points	Referenced point field
from	Start point in point field
to	End point in point field
midPoint	A point on the circumference

Definition at line 229 of file arcEdge.C.

References points.

◆ arcEdge() [5/5]

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

Construct from Istream and point field.

The Istream can specify either a point on the circumference, or with a tag to specify the origin.

Parameters

points Referenced point field

Definition at line 241 of file arcEdge.C.

References blockEdge::blockEdge(), dict, blockEdge::end_, blockEdge::firstPoint(), Foam::Info, token::isWord(), blockEdge::lastPoint(), Foam::nl, p, points, position(), Istream::putBack(), and blockEdge::start_.

Here is the call graph for this function:

◆ ~arcEdge()

virtual ~arcEdge ( )

virtualdefault

Destructor.

References lambda(), and Foam::noexcept.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "arc" )

Runtime type information.

References dict, and points.

◆ position()

Foam::point position ( const scalar lambda ) const

virtual

The point corresponding to the curve parameter [0-1].

Implements blockEdge.

Definition at line 301 of file arcEdge.C.

References blockEdge::firstPoint(), InfoInFunction, lambda(), blockEdge::lastPoint(), and Foam::nl.

Referenced by arcEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ length()

Foam::scalar length ( ) const

virtualnoexcept

The length of the curve.

Implements blockEdge.

Definition at line 324 of file arcEdge.C.

References Foam::noexcept.

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

src/mesh/blockMesh/blockEdges/arcEdge/arcEdge.H
src/mesh/blockMesh/blockEdges/arcEdge/arcEdge.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ arcEdge() [1/5]

◆ arcEdge() [2/5]

◆ arcEdge() [3/5]

◆ arcEdge() [4/5]

◆ arcEdge() [5/5]

◆ ~arcEdge()

Member Function Documentation

◆ TypeName()

◆ position()

◆ length()