Inheritance diagram for boxRefinement:

Collaboration diagram for boxRefinement:

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

	boxRefinement ()
	Null construct. More...

	boxRefinement (const word &name, const scalar cellSize, const direction additionalRefLevels, const point &centre, const scalar lengthX, const scalar lengthY, const scalar lengthZ)
	Construct from name, cell size, centre and sizes. More...

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

virtual autoPtr< objectRefinement >	clone (const boxRefinement &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 box More...

scalar	lengthX_
	length of box sides More...

scalar	lengthY_

scalar	lengthZ_

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 boxRefinement.H.

Constructor & Destructor Documentation

◆ boxRefinement() [1/3]

boxRefinement ( )

Null construct.

Definition at line 40 of file boxRefinement.C.

◆ boxRefinement() [2/3]

boxRefinement	(	const word &	name,
		const scalar	cellSize,
		const direction	additionalRefLevels,
		const point &	centre,
		const scalar	lengthX,
		const scalar	lengthY,
		const scalar	lengthZ
	)

Construct from name, cell size, centre and sizes.

Definition at line 50 of file boxRefinement.C.

References Foam::name().

Here is the call graph for this function:

◆ boxRefinement() [3/3]

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

Construct from dictionary.

Definition at line 72 of file boxRefinement.C.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "box" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Definition at line 91 of file boxRefinement.H.

References objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), boxRefinement::centre_, boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, and objectRefinement::name().

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 84 of file boxRefinement.C.

References boxRefinement::centre_, boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, and boundBox::overlaps().

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 97 of file boxRefinement.C.

References dictionary::add(), objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), boxRefinement::centre_, boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, and Foam::type().

Referenced by boxRefinement::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 120 of file boxRefinement.C.

References boxRefinement::centre_, boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, and Foam::type().

Referenced by boxRefinement::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 129 of file boxRefinement.C.

References objectRefinement::additionalRefinementLevels(), token::BEGIN_BLOCK, objectRefinement::cellSize(), boxRefinement::centre_, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, Foam::nl, 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 164 of file boxRefinement.C.

References boxRefinement::centre_, boxRefinement::dict(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), boxRefinement::lengthX_, boxRefinement::lengthY_, boxRefinement::lengthZ_, dictionary::lookup(), 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 233 of file boxRefinement.C.

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

Here is the call graph for this function:

Field Documentation

◆ centre_

point centre_

private

centre of the box

Definition at line 56 of file boxRefinement.H.

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

◆ lengthX_

scalar lengthX_

private

length of box sides

Definition at line 59 of file boxRefinement.H.

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

◆ lengthY_

scalar lengthY_

private

Definition at line 60 of file boxRefinement.H.

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

◆ lengthZ_

scalar lengthZ_

private

Definition at line 61 of file boxRefinement.H.

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

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ boxRefinement() [1/3]

◆ boxRefinement() [2/3]

◆ boxRefinement() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ intersectsObject()

◆ dict()

◆ write()

◆ writeDict()

◆ operator=()

◆ operator<<()

Field Documentation

◆ centre_

◆ lengthX_

◆ lengthY_

◆ lengthZ_