Inheritance diagram for lineRefinement:

Collaboration diagram for lineRefinement:

Public Member Functions
	TypeName ("line")
	Runtime type information. More...

	lineRefinement ()
	Null construct. More...

	lineRefinement (const word &name, const scalar cellSize, const direction additionalRefLevels, const point &p0, const point &p1)
	Construct from name, cell size, start point and end point. More...

	lineRefinement (const word &name, const dictionary &dict)
	Construct from dictionary. More...

virtual autoPtr< objectRefinement >	clone (const lineRefinement &sr) const
	Construct and return a clone. More...

bool	intersectsObject (const boundBox &) const
	check if the line intersects the box More...

dictionary	dict (bool ignoreType=false) const
	Return as dictionary of entries. More...

void	write (Ostream &) const
	Write. More...

void	writeDict (Ostream &, bool subDict=true) const
	Write dictionary. More...

void	operator= (const dictionary &)
	assign from dictionary More...

Ostream &	operator<< (Ostream &) const

Public Member Functions inherited from objectRefinement
	TypeName ("objectRefinement")

	objectRefinement ()
	Null construct. More...

	objectRefinement (const word &name, const dictionary &)
	Construct from dictionary. More...

	declareRunTimeSelectionTable (autoPtr, objectRefinement, dictionary,(const word &name, const dictionary &dict),(name, dict))

virtual	~objectRefinement ()

const word &	name () const
	Return name. More...

void	setName (const word &name)
	set the name More...

void	calculateAdditionalRefLevels (const scalar globalCellSize)
	calculate additional refinement levels from cell size More...

void	setAdditionalRefinementLevels (const direction addRefLevels)
	set the number of additional refinement level More...

direction	additionalRefinementLevels () const
	return the number of additional refinement levels More...

void	setRefinementThickness (const scalar refThickness)
	set refinement thickness More...

scalar	refinementThickness () const
	return refinement thickness for this object More...

Private Attributes
point	p0_
	start point of the line More...

point	p1_
	end point of the line More...

Additional Inherited Members
Static Public Member Functions inherited from objectRefinement
static autoPtr< objectRefinement >	New (const word &name, const dictionary &dict)
	Select constructed from dictionary. More...

Protected Member Functions inherited from objectRefinement
void	setCellSize (const scalar cellSize)
	set cell size More...

scalar	cellSize () const
	return cell size More...

Protected Attributes inherited from objectRefinement
word	name_
	Name of object refinement type. More...

scalar	cellSize_
	cell size for this object More...

label	additionalRefLevel_
	refinement level applicable to this object More...

scalar	refThickness_
	refinement thickness fro this object More...

Detailed Description

Definition at line 50 of file lineRefinement.H.

Constructor & Destructor Documentation

◆ lineRefinement() [1/3]

lineRefinement ( )

Null construct.

Definition at line 40 of file lineRefinement.C.

◆ lineRefinement() [2/3]

lineRefinement	(	const word &	name,
		const scalar	cellSize,
		const direction	additionalRefLevels,
		const point &	p0,
		const point &	p1
	)

Construct from name, cell size, start point and end point.

Definition at line 48 of file lineRefinement.C.

References Foam::name().

Here is the call graph for this function:

◆ lineRefinement() [3/3]

lineRefinement	(	const word &	name,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 66 of file lineRefinement.C.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "line" )

Runtime type information.

◆ clone()

virtual autoPtr<objectRefinement> clone ( const lineRefinement & sr ) const

inlinevirtual

Construct and return a clone.

Definition at line 87 of file lineRefinement.H.

References objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), objectRefinement::name(), lineRefinement::p0_, and lineRefinement::p1_.

Here is the call graph for this function:

◆ intersectsObject()

bool intersectsObject ( const boundBox & bb ) const

virtual

check if the line intersects the box

check if the cube contains start point or end point

check for intersections of line with the cube faces

x-min face

x-max face

y-min face

y-max face

z-min face

Implements objectRefinement.

Definition at line 78 of file lineRefinement.C.

References Foam::mag(), boundBox::max(), Foam::max(), boundBox::min(), Foam::min(), n, lineRefinement::p0_, lineRefinement::p1_, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ dict()

dictionary dict ( bool ignoreType = false ) const

virtual

Return as dictionary of entries.

Implements objectRefinement.

Definition at line 209 of file lineRefinement.C.

References dictionary::add(), objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), lineRefinement::p0_, lineRefinement::p1_, and Foam::type().

Referenced by lineRefinement::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Implements objectRefinement.

Definition at line 230 of file lineRefinement.C.

References lineRefinement::p0_, lineRefinement::p1_, and Foam::type().

Referenced by lineRefinement::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict	(	Ostream &	os,
		bool	subDict = `true`
	)		const

virtual

Write dictionary.

Implements objectRefinement.

Definition at line 237 of file lineRefinement.C.

References objectRefinement::additionalRefinementLevels(), token::BEGIN_BLOCK, objectRefinement::cellSize(), Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::nl, lineRefinement::p0_, lineRefinement::p1_, Foam::type(), and Ostream::writeKeyword().

Here is the call graph for this function:

◆ operator=()

void operator= ( const dictionary & d )

virtual

assign from dictionary

Implements objectRefinement.

Definition at line 270 of file lineRefinement.C.

References lineRefinement::dict(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), dictionary::lookup(), lineRefinement::p0_, lineRefinement::p1_, dictionary::subDict(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ operator<<()

Ostream & operator<< ( Ostream & os ) const

Definition at line 311 of file lineRefinement.C.

References objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), Foam::endl(), objectRefinement::name(), Foam::nl, and lineRefinement::write().

Here is the call graph for this function:

Field Documentation

◆ p0_

point p0_

private

start point of the line

Definition at line 56 of file lineRefinement.H.

Referenced by lineRefinement::clone(), lineRefinement::dict(), lineRefinement::intersectsObject(), lineRefinement::operator=(), lineRefinement::write(), and lineRefinement::writeDict().

◆ p1_

point p1_

private

end point of the line

Definition at line 59 of file lineRefinement.H.

Referenced by lineRefinement::clone(), lineRefinement::dict(), lineRefinement::intersectsObject(), lineRefinement::operator=(), lineRefinement::write(), and lineRefinement::writeDict().

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

applications/extra/cfMesh-v1.1.2/meshLibrary/utilities/octrees/meshOctree/refinementControls/objectRefinement/lineRefinement.H
applications/extra/cfMesh-v1.1.2/meshLibrary/utilities/octrees/meshOctree/refinementControls/objectRefinement/lineRefinement.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ lineRefinement() [1/3]

◆ lineRefinement() [2/3]

◆ lineRefinement() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ intersectsObject()

◆ dict()

◆ write()

◆ writeDict()

◆ operator=()

◆ operator<<()

Field Documentation

◆ p0_

◆ p1_