Inheritance diagram for sphereRefinement:

Collaboration diagram for sphereRefinement:

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

	sphereRefinement ()
	Null construct. More...

	sphereRefinement (const word &name, const scalar cellSize, const direction additionalRefLevels, const point &centre, const scalar radius)
	Construct from name, cell size, centre and radius. More...

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

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

bool	intersectsObject (const boundBox &) const
	check if a boundBox intersects or is inside the object 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	centre_
	centre of the sphere More...

scalar	radius_
	radius of the sphere 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 sphereRefinement.H.

Constructor & Destructor Documentation

◆ sphereRefinement() [1/3]

sphereRefinement ( )

Null construct.

Definition at line 40 of file sphereRefinement.C.

◆ sphereRefinement() [2/3]

sphereRefinement	(	const word &	name,
		const scalar	cellSize,
		const direction	additionalRefLevels,
		const point &	centre,
		const scalar	radius
	)

Construct from name, cell size, centre and radius.

Definition at line 48 of file sphereRefinement.C.

References Foam::name().

Here is the call graph for this function:

◆ sphereRefinement() [3/3]

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

Construct from dictionary.

Definition at line 66 of file sphereRefinement.C.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "sphere" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Definition at line 87 of file sphereRefinement.H.

References objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), sphereRefinement::centre_, objectRefinement::name(), and sphereRefinement::radius_.

Here is the call graph for this function:

◆ intersectsObject()

bool intersectsObject ( const boundBox & bb ) const

virtual

check if a boundBox intersects or is inside the object

Implements objectRefinement.

Definition at line 78 of file sphereRefinement.C.

References Foam::constant::universal::c, sphereRefinement::centre_, Foam::magSqr(), boundBox::max(), boundBox::min(), sphereRefinement::radius_, and Foam::sqr().

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 90 of file sphereRefinement.C.

References dictionary::add(), objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), sphereRefinement::centre_, sphereRefinement::radius_, and Foam::type().

Referenced by sphereRefinement::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 111 of file sphereRefinement.C.

References sphereRefinement::centre_, sphereRefinement::radius_, and Foam::type().

Referenced by sphereRefinement::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 118 of file sphereRefinement.C.

References objectRefinement::additionalRefinementLevels(), token::BEGIN_BLOCK, objectRefinement::cellSize(), sphereRefinement::centre_, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::nl, sphereRefinement::radius_, 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 151 of file sphereRefinement.C.

References sphereRefinement::centre_, sphereRefinement::dict(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), dictionary::lookup(), sphereRefinement::radius_, Foam::readScalar(), dictionary::subDict(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ operator<<()

Ostream & operator<< ( Ostream & os ) const

Definition at line 192 of file sphereRefinement.C.

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

Here is the call graph for this function:

Field Documentation

◆ centre_

point centre_

private

centre of the sphere

Definition at line 56 of file sphereRefinement.H.

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

◆ radius_

scalar radius_

private

radius of the sphere

Definition at line 59 of file sphereRefinement.H.

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

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sphereRefinement() [1/3]

◆ sphereRefinement() [2/3]

◆ sphereRefinement() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ intersectsObject()

◆ dict()

◆ write()

◆ writeDict()

◆ operator=()

◆ operator<<()

Field Documentation

◆ centre_

◆ radius_