Public Member Functions | Private Attributes
coneRefinement Class Reference
Inheritance diagram for coneRefinement:
Inheritance graph
[legend]
Collaboration diagram for coneRefinement:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("cone")
 Runtime type information. More...
 
 coneRefinement ()
 Null construct. More...
 
 coneRefinement (const word &name, const scalar cellSize, const direction additionalRefLevels, const point &p0, const scalar radius0, const point &p1, const scalar radius1)
 Construct from name, cell size, centre and radius. More...
 
 coneRefinement (const word &name, const dictionary &dict)
 Construct from dictionary. More...
 
virtual autoPtr< objectRefinementclone (const coneRefinement &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...
 
Ostreamoperator<< (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 wordname () 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 and the radius More...
 
scalar r0_
 
point p1_
 end point and the radius More...
 
scalar r1_
 

Additional Inherited Members

- Static Public Member Functions inherited from objectRefinement
static autoPtr< objectRefinementNew (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 coneRefinement.H.

Constructor & Destructor Documentation

◆ coneRefinement() [1/3]

Null construct.

Definition at line 40 of file coneRefinement.C.

◆ coneRefinement() [2/3]

coneRefinement ( const word name,
const scalar  cellSize,
const direction  additionalRefLevels,
const point p0,
const scalar  radius0,
const point p1,
const scalar  radius1 
)

Construct from name, cell size, centre and radius.

Definition at line 50 of file coneRefinement.C.

References Foam::name().

Here is the call graph for this function:

◆ coneRefinement() [3/3]

coneRefinement ( const word name,
const dictionary dict 
)

Construct from dictionary.

Definition at line 72 of file coneRefinement.C.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "cone"  )

Runtime type information.

◆ clone()

virtual autoPtr<objectRefinement> clone ( const coneRefinement sr) const
inlinevirtual

Construct and return a clone.

Definition at line 91 of file coneRefinement.H.

References objectRefinement::additionalRefinementLevels(), objectRefinement::cellSize(), objectRefinement::name(), coneRefinement::p0_, coneRefinement::p1_, coneRefinement::r0_, and coneRefinement::r1_.

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

check if the centre is inside the cone

Implements objectRefinement.

Definition at line 84 of file coneRefinement.C.

References Foam::constant::universal::c, Foam::mag(), Foam::magSqr(), boundBox::max(), boundBox::min(), coneRefinement::p0_, coneRefinement::p1_, coneRefinement::r0_, and coneRefinement::r1_.

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 109 of file coneRefinement.C.

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

Referenced by coneRefinement::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 132 of file coneRefinement.C.

References coneRefinement::p0_, coneRefinement::p1_, coneRefinement::r0_, coneRefinement::r1_, and Foam::type().

Referenced by coneRefinement::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

◆ operator=()

void operator= ( const dictionary d)
virtual

◆ operator<<()

Ostream & operator<< ( Ostream os) const

Field Documentation

◆ p0_

point p0_
private

◆ r0_

scalar r0_
private

◆ p1_

point p1_
private

◆ r1_

scalar r1_
private

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