cellSizeFunction Class Referenceabstract

Abstract base class for specifying target cell sizes. More...

Inheritance diagram for cellSizeFunction:
Collaboration diagram for cellSizeFunction:

Public Types

enum  sideMode { smInside, smOutside, rmBothsides }
 Surface side mode. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Public Member Functions

 TypeName ("cellSizeFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, cellSizeFunction, dictionary,(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices),(cellSizeFunctionDict, surface, defaultCellSize, regionIndices))
 
 cellSizeFunction (const word &type, const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)
 Construct from components. More...
 
 cellSizeFunction (const cellSizeFunction &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~cellSizeFunction ()
 Destructor. More...
 
const dictionarycoeffsDict () const
 Const access to the details dictionary. More...
 
virtual bool sizeLocations (const pointIndexHit &hitPt, const vector &n, pointField &shapePts, scalarField &shapeSizes) const =0
 
virtual bool cellSize (const point &pt, scalar &size) const =0
 Modify scalar argument to the cell size specified by function. More...
 
virtual bool setCellSize (const pointField &pts)
 
label priority () const
 
void operator= (const cellSizeFunction &)=delete
 Disallow default bitwise assignment. More...
 
- 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 &, const bool keepHeader=false)
 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, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. 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 lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. 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...
 
dictionarysubDictPtr (const word &)
 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...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted 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...
 
bool read (Istream &, const bool keepHeader=false)
 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= (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...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. 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...
 
void operator= (const dictionaryName &name)
 
void operator= (dictionaryName &&name)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 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 > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

Static Public Member Functions

static autoPtr< cellSizeFunctionNew (const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)
 Return a reference to the selected cellSizeFunction. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 

Protected Attributes

const searchableSurfacesurface_
 Reference to the searchableSurface that cellSizeFunction. More...
 
scalarField surfaceCellSize_
 Cell size at the surface. More...
 
autoPtr< surfaceCellSizeFunctionsurfaceCellSizeFunction_
 
dictionary coeffsDict_
 Method details dictionary. More...
 
const scalar & defaultCellSize_
 
const labelList regionIndices_
 Index of the region of the surface that this cell size function. More...
 
sideMode sideMode_
 Mode of size specification, i.e. inside, outside or bothSides. More...
 
label priority_
 

Static Protected Attributes

static scalar snapToSurfaceTol_
 Point closeness tolerance to a surface where the function "snaps" to. More...
 

Additional Inherited Members

- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Detailed Description

Abstract base class for specifying target cell sizes.

Source files

Definition at line 54 of file cellSizeFunction.H.

Member Enumeration Documentation

◆ sideMode

enum sideMode

Surface side mode.

Enumerator
smInside 
smOutside 
rmBothsides 

Definition at line 62 of file cellSizeFunction.H.

Constructor & Destructor Documentation

◆ cellSizeFunction() [1/2]

cellSizeFunction ( const word type,
const dictionary cellSizeFunctionDict,
const searchableSurface surface,
const scalar &  defaultCellSize,
const labelList  regionIndices 
)

Construct from components.

◆ cellSizeFunction() [2/2]

cellSizeFunction ( const cellSizeFunction )
delete

Disallow default bitwise copy construction.

◆ ~cellSizeFunction()

virtual ~cellSizeFunction ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cellSizeFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
cellSizeFunction  ,
dictionary  ,
(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)  ,
(cellSizeFunctionDict, surface, defaultCellSize, regionIndices)   
)

◆ New()

static autoPtr<cellSizeFunction> New ( const dictionary cellSizeFunctionDict,
const searchableSurface surface,
const scalar &  defaultCellSize,
const labelList  regionIndices 
)
static

Return a reference to the selected cellSizeFunction.

◆ coeffsDict()

const dictionary& coeffsDict ( ) const
inline

Const access to the details dictionary.

Definition at line 162 of file cellSizeFunction.H.

References cellSizeFunction::cellSize(), cellSizeFunction::coeffsDict_, n, cellSizeFunction::setCellSize(), and cellSizeFunction::sizeLocations().

Here is the call graph for this function:

◆ sizeLocations()

virtual bool sizeLocations ( const pointIndexHit hitPt,
const vector n,
pointField shapePts,
scalarField shapeSizes 
) const
pure virtual

Implemented in linearSpatial, surfaceOffsetLinearDistance, linearDistance, uniformDistance, and uniform.

Referenced by cellSizeFunction::coeffsDict().

Here is the caller graph for this function:

◆ cellSize()

virtual bool cellSize ( const point pt,
scalar &  size 
) const
pure virtual

Modify scalar argument to the cell size specified by function.

Return a boolean specifying if the function was used, i.e. false if the point was not in range of the surface for a spatially varying size.

Implemented in linearSpatial, surfaceOffsetLinearDistance, linearDistance, uniformDistance, and uniform.

Referenced by cellSizeFunction::coeffsDict().

Here is the caller graph for this function:

◆ setCellSize()

virtual bool setCellSize ( const pointField pts)
inlinevirtual

Reimplemented in linearDistance, uniformDistance, and uniform.

Definition at line 187 of file cellSizeFunction.H.

References Foam::endl(), and WarningInFunction.

Referenced by cellSizeFunction::coeffsDict().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ priority()

label priority ( ) const
inline

Definition at line 197 of file cellSizeFunction.H.

References cellSizeFunction::operator=(), and cellSizeFunction::priority_.

Here is the call graph for this function:

◆ operator=()

void operator= ( const cellSizeFunction )
delete

Disallow default bitwise assignment.

Referenced by cellSizeFunction::priority().

Here is the caller graph for this function:

Member Data Documentation

◆ snapToSurfaceTol_

scalar snapToSurfaceTol_
staticprotected

Point closeness tolerance to a surface where the function "snaps" to.

including the surface

Definition at line 79 of file cellSizeFunction.H.

◆ surface_

const searchableSurface& surface_
protected

Reference to the searchableSurface that cellSizeFunction.

relates to

Definition at line 86 of file cellSizeFunction.H.

◆ surfaceCellSize_

scalarField surfaceCellSize_
protected

Cell size at the surface.

Definition at line 89 of file cellSizeFunction.H.

◆ surfaceCellSizeFunction_

autoPtr<surfaceCellSizeFunction> surfaceCellSizeFunction_
protected

Definition at line 91 of file cellSizeFunction.H.

◆ coeffsDict_

dictionary coeffsDict_
protected

Method details dictionary.

Definition at line 94 of file cellSizeFunction.H.

Referenced by cellSizeFunction::coeffsDict().

◆ defaultCellSize_

const scalar& defaultCellSize_
protected

Definition at line 96 of file cellSizeFunction.H.

◆ regionIndices_

const labelList regionIndices_
protected

Index of the region of the surface that this cell size function.

applies to

Definition at line 100 of file cellSizeFunction.H.

◆ sideMode_

sideMode sideMode_
protected

Mode of size specification, i.e. inside, outside or bothSides.

Definition at line 103 of file cellSizeFunction.H.

◆ priority_

label priority_
protected

Definition at line 105 of file cellSizeFunction.H.

Referenced by cellSizeFunction::priority().


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