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

Public Member Functions

 ClassName ("cellShapeControl")
 Runtime type information. More...
 
 cellShapeControl (const Time &runTime, const cvControls &foamyHexMeshControls, const searchableSurfaces &allGeometry, const conformationSurfaces &geometryToConformTo)
 Construct from dictionary and references to conformalVoronoiMesh and. More...
 
 ~cellShapeControl ()
 Destructor. More...
 
const scalar & defaultCellSize () const
 
cellShapeControlMeshshapeControlMesh ()
 
const cellShapeControlMeshshapeControlMesh () const
 
const cellAspectRatioControlaspectRatio () const
 
const cellSizeAndAlignmentControlssizeAndAlignment () const
 
const scalar & minimumCellSize () const
 
scalar cellSize (const point &pt) const
 Return the cell size at the given location. More...
 
scalarField cellSize (const pointField &pts) const
 
tensor cellAlignment (const point &pt) const
 Return the cell alignment at the given location. More...
 
void cellSizeAndAlignment (const point &pt, scalar &size, tensor &alignment) const
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
wordList toc () const
 Return the table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Construct as copy. More...
 
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 

Private Member Functions

 cellShapeControl (const cellShapeControl &)
 Disallow default bitwise copy construct. More...
 
void operator= (const cellShapeControl &)
 Disallow default bitwise assignment. More...
 

Private Attributes

const TimerunTime_
 
const searchableSurfacesallGeometry_
 
const conformationSurfacesgeometryToConformTo_
 
const scalar defaultCellSize_
 
const scalar minimumCellSize_
 
cellShapeControlMesh shapeControlMesh_
 
cellAspectRatioControl aspectRatio_
 
cellSizeAndAlignmentControls sizeAndAlignment_
 

Additional Inherited Members

- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Detailed Description

Source files

Definition at line 62 of file cellShapeControl.H.

Constructor & Destructor Documentation

◆ cellShapeControl() [1/2]

cellShapeControl ( const cellShapeControl )
private

Disallow default bitwise copy construct.

◆ cellShapeControl() [2/2]

cellShapeControl ( const Time runTime,
const cvControls foamyHexMeshControls,
const searchableSurfaces allGeometry,
const conformationSurfaces geometryToConformTo 
)

Construct from dictionary and references to conformalVoronoiMesh and.

searchableSurfaces

◆ ~cellShapeControl()

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const cellShapeControl )
private

Disallow default bitwise assignment.

◆ ClassName()

ClassName ( "cellShapeControl"  )

Runtime type information.

◆ defaultCellSize()

const Foam::scalar & defaultCellSize ( ) const
inline

Definition at line 42 of file cellShapeControlI.H.

◆ shapeControlMesh() [1/2]

const Foam::cellShapeControlMesh & shapeControlMesh ( )
inline

Definition at line 29 of file cellShapeControlI.H.

References cellShapeControl::shapeControlMesh_.

◆ shapeControlMesh() [2/2]

const cellShapeControlMesh& shapeControlMesh ( ) const
inline

◆ aspectRatio()

const Foam::cellAspectRatioControl & aspectRatio ( ) const
inline

Definition at line 49 of file cellShapeControlI.H.

◆ sizeAndAlignment()

const Foam::cellSizeAndAlignmentControls & sizeAndAlignment ( ) const
inline

Definition at line 56 of file cellShapeControlI.H.

◆ minimumCellSize()

const Foam::scalar & minimumCellSize ( ) const
inline

Definition at line 62 of file cellShapeControlI.H.

◆ cellSize() [1/2]

scalar cellSize ( const point pt) const

Return the cell size at the given location.

◆ cellSize() [2/2]

scalarField cellSize ( const pointField pts) const

◆ cellAlignment()

tensor cellAlignment ( const point pt) const

Return the cell alignment at the given location.

◆ cellSizeAndAlignment()

void cellSizeAndAlignment ( const point pt,
scalar &  size,
tensor alignment 
) const

Field Documentation

◆ runTime_

const Time& runTime_
private

Definition at line 68 of file cellShapeControl.H.

◆ allGeometry_

const searchableSurfaces& allGeometry_
private

Definition at line 70 of file cellShapeControl.H.

◆ geometryToConformTo_

const conformationSurfaces& geometryToConformTo_
private

Definition at line 72 of file cellShapeControl.H.

◆ defaultCellSize_

const scalar defaultCellSize_
private

Definition at line 74 of file cellShapeControl.H.

◆ minimumCellSize_

const scalar minimumCellSize_
private

Definition at line 76 of file cellShapeControl.H.

◆ shapeControlMesh_

cellShapeControlMesh shapeControlMesh_
private

Definition at line 78 of file cellShapeControl.H.

Referenced by cellShapeControl::shapeControlMesh().

◆ aspectRatio_

cellAspectRatioControl aspectRatio_
private

Definition at line 80 of file cellShapeControl.H.

◆ sizeAndAlignment_

cellSizeAndAlignmentControls sizeAndAlignment_
private

Definition at line 82 of file cellShapeControl.H.


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