Inheritance diagram for objectRefinement:

[legend]

Collaboration diagram for objectRefinement:

Public Member Functions
	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 ()

virtual bool	intersectsObject (const boundBox &) const =0
	check if a boundBox intersects or is inside the object More...

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

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

virtual void	write (Ostream &) const =0
	Write. More...

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

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

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

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

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

Protected Attributes
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...

Friends
Ostream &	operator<< (Ostream &, const objectRefinement &)

Detailed Description

Definition at line 54 of file objectRefinement.H.

Constructor & Destructor Documentation

◆ objectRefinement() [1/2]

objectRefinement ( )

Null construct.

Definition at line 40 of file objectRefinement.C.

◆ objectRefinement() [2/2]

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

Construct from dictionary.

Definition at line 49 of file objectRefinement.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), dictionary::lookup(), Foam::readLabel(), and Foam::readScalar().

Here is the call graph for this function:

◆ ~objectRefinement()

~objectRefinement ( )

virtual

Definition at line 95 of file objectRefinement.C.

Member Function Documentation

◆ setCellSize()

void setCellSize ( const scalar cellSize )

inlineprotected

set cell size

Definition at line 74 of file objectRefinement.H.

References objectRefinement::cellSize(), and objectRefinement::cellSize_.

Here is the call graph for this function:

◆ cellSize()

scalar cellSize ( ) const

inlineprotected

return cell size

Definition at line 80 of file objectRefinement.H.

References objectRefinement::cellSize_.

Referenced by lineRefinement::clone(), sphereRefinement::clone(), coneRefinement::clone(), boxRefinement::clone(), hollowConeRefinement::clone(), sphereRefinement::dict(), lineRefinement::dict(), boxRefinement::dict(), coneRefinement::dict(), hollowConeRefinement::dict(), sphereRefinement::operator<<(), lineRefinement::operator<<(), coneRefinement::operator<<(), boxRefinement::operator<<(), hollowConeRefinement::operator<<(), objectRefinement::setCellSize(), lineRefinement::writeDict(), sphereRefinement::writeDict(), coneRefinement::writeDict(), boxRefinement::writeDict(), and hollowConeRefinement::writeDict().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "objectRefinement" )

◆ declareRunTimeSelectionTable()

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

◆ New()

autoPtr< Foam::objectRefinement > New	(	const word &	name,
		const dictionary &	dict
	)

static

Select constructed from dictionary.

Definition at line 38 of file newObjectRefinement.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by checkMeshDict::checkObjectRefinements(), and meshOctreeCreator::refineBoxesContainedInObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersectsObject()

virtual bool intersectsObject ( const boundBox & ) const

pure virtual

check if a boundBox intersects or is inside the object

Implemented in hollowConeRefinement, boxRefinement, coneRefinement, lineRefinement, and sphereRefinement.

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 136 of file objectRefinement.H.

References objectRefinement::name_.

Referenced by lineRefinement::clone(), sphereRefinement::clone(), boxRefinement::clone(), coneRefinement::clone(), hollowConeRefinement::clone(), Foam::operator<<(), sphereRefinement::operator<<(), lineRefinement::operator<<(), boxRefinement::operator<<(), coneRefinement::operator<<(), hollowConeRefinement::operator<<(), and objectRefinement::setName().

Here is the caller graph for this function:

◆ setName()

void setName ( const word & name )

inline

set the name

Definition at line 142 of file objectRefinement.H.

References objectRefinement::name(), and objectRefinement::name_.

Here is the call graph for this function:

◆ calculateAdditionalRefLevels()

void calculateAdditionalRefLevels ( const scalar globalCellSize )

calculate additional refinement levels from cell size

Definition at line 108 of file objectRefinement.C.

References objectRefinement::additionalRefLevel_, objectRefinement::cellSize_, and s().

Here is the call graph for this function:

◆ setAdditionalRefinementLevels()

void setAdditionalRefinementLevels ( const direction addRefLevels )

inline

set the number of additional refinement level

Definition at line 151 of file objectRefinement.H.

References objectRefinement::additionalRefLevel_.

◆ additionalRefinementLevels()

direction additionalRefinementLevels ( ) const

inline

return the number of additional refinement levels

Definition at line 157 of file objectRefinement.H.

References objectRefinement::additionalRefLevel_.

Referenced by lineRefinement::clone(), sphereRefinement::clone(), coneRefinement::clone(), boxRefinement::clone(), hollowConeRefinement::clone(), sphereRefinement::dict(), lineRefinement::dict(), boxRefinement::dict(), coneRefinement::dict(), hollowConeRefinement::dict(), sphereRefinement::operator<<(), lineRefinement::operator<<(), boxRefinement::operator<<(), coneRefinement::operator<<(), hollowConeRefinement::operator<<(), sphereRefinement::writeDict(), lineRefinement::writeDict(), boxRefinement::writeDict(), coneRefinement::writeDict(), and hollowConeRefinement::writeDict().

Here is the caller graph for this function:

◆ setRefinementThickness()

void setRefinementThickness ( const scalar refThickness )

inline

set refinement thickness

Definition at line 163 of file objectRefinement.H.

References objectRefinement::refThickness_.

◆ refinementThickness()

scalar refinementThickness ( ) const

inline

return refinement thickness for this object

Definition at line 169 of file objectRefinement.H.

References objectRefinement::refThickness_.

◆ dict()

virtual dictionary dict ( bool ignoreType = false ) const

pure virtual

Return as dictionary of entries.

Implemented in hollowConeRefinement, boxRefinement, coneRefinement, lineRefinement, and sphereRefinement.

◆ write()

virtual void write ( Ostream & ) const

pure virtual

Write.

Implemented in hollowConeRefinement, boxRefinement, coneRefinement, lineRefinement, and sphereRefinement.

◆ writeDict()

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

pure virtual

Write dictionary.

Implemented in hollowConeRefinement, boxRefinement, coneRefinement, lineRefinement, and sphereRefinement.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ operator=()

virtual void operator= ( const dictionary & )

pure virtual

assign from dictionary

Implemented in hollowConeRefinement, boxRefinement, coneRefinement, lineRefinement, and sphereRefinement.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const objectRefinement &	obr
	)

friend

Definition at line 101 of file objectRefinement.C.

Field Documentation

◆ name_

word name_

protected

Name of object refinement type.

Definition at line 61 of file objectRefinement.H.

Referenced by objectRefinement::name(), and objectRefinement::setName().

◆ cellSize_

scalar cellSize_

protected

cell size for this object

Definition at line 64 of file objectRefinement.H.

Referenced by objectRefinement::calculateAdditionalRefLevels(), objectRefinement::cellSize(), and objectRefinement::setCellSize().

◆ additionalRefLevel_

label additionalRefLevel_

protected

refinement level applicable to this object

Definition at line 67 of file objectRefinement.H.

Referenced by objectRefinement::additionalRefinementLevels(), objectRefinement::calculateAdditionalRefLevels(), and objectRefinement::setAdditionalRefinementLevels().

◆ refThickness_

scalar refThickness_

protected

refinement thickness fro this object

Definition at line 70 of file objectRefinement.H.

Referenced by objectRefinement::refinementThickness(), and objectRefinement::setRefinementThickness().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ objectRefinement() [1/2]

◆ objectRefinement() [2/2]

◆ ~objectRefinement()

Member Function Documentation

◆ setCellSize()

◆ cellSize()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ intersectsObject()

◆ name()

◆ setName()

◆ calculateAdditionalRefLevels()

◆ setAdditionalRefinementLevels()

◆ additionalRefinementLevels()

◆ setRefinementThickness()

◆ refinementThickness()

◆ dict()

◆ write()

◆ writeDict()

◆ operator=()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ name_

◆ cellSize_

◆ additionalRefLevel_

◆ refThickness_