blockMesh Class Reference

A multi-block mesh generator. More...

Inheritance diagram for blockMesh:
Collaboration diagram for blockMesh:

Public Member Functions

 ClassName ("blockMesh")
 
 blockMesh (const IOdictionary &, const word &regionName)
 Construct from IOdictionary. More...
 
 blockMesh (const blockMesh &)=delete
 Disallow default bitwise copy construction. More...
 
 ~blockMesh ()
 Destructor. More...
 
const dictionarymeshDict () const
 Access to input dictionary. More...
 
const searchableSurfacesgeometry () const
 Optional searchable geometry to project face-points to. More...
 
const pointFieldvertices () const
 Reference to point field defining the blockMesh. More...
 
const polyMeshtopology () const
 Return the blockMesh topology as a polyMesh. More...
 
const blockEdgeListedges () const
 Return the curved edges. More...
 
const blockFaceListfaces () const
 Return the curved faces. More...
 
scalar scaleFactor () const
 The scaling factor used to convert to meters. More...
 
const pointFieldpoints () const
 The points for the entire mesh. More...
 
const cellShapeListcells () const
 Return cell shapes list. More...
 
const faceListListpatches () const
 Return the patch face lists. More...
 
PtrList< dictionarypatchDicts () const
 Get patch information from the topology mesh. More...
 
wordList patchNames () const
 Return patch names. More...
 
label numZonedBlocks () const
 Number of blocks with specified zones. More...
 
void verbose (const bool on=true)
 Enable/disable verbose information about the progress. More...
 
void writeTopology (Ostream &) const
 Writes edges of blockMesh in OBJ format. More...
 
void operator= (const blockMesh &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from PtrList< T >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< T > &)
 Copy constructor. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (PtrList< T > &&)
 Move constructor. More...
 
 PtrList (PtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T> More...
 
template<class INew >
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 
void append (const tmp< T > &)
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< Tset (const label, const tmp< T > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< T > &)
 Assignment operator. More...
 
void operator= (PtrList< T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
template<class T2 >
UPtrList< T2 > convert ()
 Convert to list of different pointer type. More...
 
template<class T2 >
UPtrList< const T2 > convert () const
 Convert to list of different pointer type. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
Toperator() (const label)
 Return element const pointer. More...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 
template<class T2 >
Foam::UPtrList< T2 > convert ()
 
template<class T2 >
Foam::UPtrList< const T2 > convert () const
 

Static Public Attributes

static Switch checkBlockFaceOrientation
 Switch checking block face orientation. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< T >
template<class INew >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

A multi-block mesh generator.

Note: The vertices, cells and patches for filling the blocks are demand-driven.

Source files

Definition at line 62 of file blockMesh.H.

Constructor & Destructor Documentation

◆ blockMesh() [1/2]

blockMesh ( const IOdictionary ,
const word regionName 
)

Construct from IOdictionary.

◆ blockMesh() [2/2]

blockMesh ( const blockMesh )
delete

Disallow default bitwise copy construction.

◆ ~blockMesh()

~blockMesh ( )

Destructor.

Member Function Documentation

◆ ClassName()

ClassName ( "blockMesh"  )

◆ meshDict()

const dictionary& meshDict ( ) const
inline

Access to input dictionary.

Definition at line 232 of file blockMesh.H.

◆ geometry()

const searchableSurfaces& geometry ( ) const
inline

Optional searchable geometry to project face-points to.

Definition at line 238 of file blockMesh.H.

◆ vertices()

const pointField& vertices ( ) const

Reference to point field defining the blockMesh.

these points have not been scaled by scaleFactor

◆ topology()

const polyMesh& topology ( ) const

Return the blockMesh topology as a polyMesh.

◆ edges()

const blockEdgeList& edges ( ) const
inline

Return the curved edges.

Definition at line 251 of file blockMesh.H.

◆ faces()

const blockFaceList& faces ( ) const
inline

Return the curved faces.

Definition at line 257 of file blockMesh.H.

◆ scaleFactor()

scalar scaleFactor ( ) const

The scaling factor used to convert to meters.

◆ points()

const pointField& points ( ) const

The points for the entire mesh.

these points have been scaled by scaleFactor

◆ cells()

const cellShapeList& cells ( ) const

Return cell shapes list.

◆ patches()

const faceListList& patches ( ) const

Return the patch face lists.

◆ patchDicts()

PtrList<dictionary> patchDicts ( ) const

Get patch information from the topology mesh.

◆ patchNames()

wordList patchNames ( ) const

Return patch names.

◆ numZonedBlocks()

label numZonedBlocks ( ) const

Number of blocks with specified zones.

◆ verbose()

void verbose ( const bool  on = true)

Enable/disable verbose information about the progress.

◆ writeTopology()

void writeTopology ( Ostream ) const

Writes edges of blockMesh in OBJ format.

◆ operator=()

void operator= ( const blockMesh )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ checkBlockFaceOrientation

Switch checkBlockFaceOrientation
static

Switch checking block face orientation.

to ensure that all faces are outward-pointing. This check may fail if the block is intentionally very twisted for curved edges to be applied and can be switched off.

Definition at line 211 of file blockMesh.H.

Referenced by blockDescriptor::blockDescriptor().


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