blockMesh Class Reference

A multi-block mesh generator. More...

Inheritance diagram for blockMesh:
[legend]
Collaboration diagram for blockMesh:
[legend]

Public Member Functions

 ClassName ("blockMesh")
 
 blockMesh (const IOdictionary &dict, const word &regionName)
 Construct from IOdictionary. More...
 
 ~blockMesh ()=default
 Destructor. More...
 
const dictionarymeshDict () const
 Access to input dictionary. More...
 
const searchableSurfacesgeometry () const
 Optional searchable geometry to project face-points to. More...
 
bool valid () const
 True if the blockMesh topology exists. 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 metres. 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...
 
- Public Member Functions inherited from PtrList< T >
constexpr PtrList () noexcept
 Construct null. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< T > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< T > &&list)
 Move construct. More...
 
 PtrList (UList< T * > &list)
 Take ownerskip of pointers in the list, set old pointers to null. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< T > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
template<class INew >
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
template<class... Args>
PtrList< Tclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< T > &aptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< T > &&aptr)
 Move append an element to the end of the list. More...
 
void append (const tmp< T > &tptr)
 Move or clone append a tmp to the end of the list. More...
 
void transfer (PtrList< T > &list)
 Transfer into this list and annul the argument list. More...
 
const Tset (const label i) const
 Return const pointer to element (if set) or nullptr. More...
 
autoPtr< Tset (const label i, T *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< Tset (const label i, autoPtr< T > &aptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, autoPtr< T > &&aptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, const tmp< T > &tptr)
 Set element to given tmp and return old element. More...
 
autoPtr< Trelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void operator= (const PtrList< T > &list)
 Copy assignment. More...
 
void operator= (PtrList< T > &&list)
 Move assignment. More...
 
template<class... Args>
Foam::PtrList< Tclone (Args &&... args) const
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< T >
template<class INew >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. 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 64 of file blockMesh.H.

Constructor & Destructor Documentation

◆ blockMesh()

blockMesh ( const IOdictionary dict,
const word regionName 
)

Construct from IOdictionary.

Definition at line 42 of file blockMesh.C.

References dictionary::lookupOrDefault().

Here is the call graph for this function:

◆ ~blockMesh()

~blockMesh ( )
default

Destructor.

Member Function Documentation

◆ ClassName()

ClassName ( "blockMesh"  )

◆ meshDict()

const dictionary& meshDict ( ) const
inline

Access to input dictionary.

Definition at line 199 of file blockMesh.H.

◆ geometry()

const searchableSurfaces& geometry ( ) const
inline

Optional searchable geometry to project face-points to.

Definition at line 205 of file blockMesh.H.

◆ valid()

bool valid ( ) const

True if the blockMesh topology exists.

Definition at line 88 of file blockMesh.C.

◆ vertices()

const Foam::pointField & vertices ( ) const

Reference to point field defining the blockMesh.

these points have not been scaled by scaleFactor

Definition at line 100 of file blockMesh.C.

◆ topology()

const Foam::polyMesh & topology ( ) const

Return the blockMesh topology as a polyMesh.

Definition at line 106 of file blockMesh.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ edges()

const blockEdgeList& edges ( ) const
inline

Return the curved edges.

Definition at line 221 of file blockMesh.H.

◆ faces()

const blockFaceList& faces ( ) const
inline

Return the curved faces.

Definition at line 227 of file blockMesh.H.

◆ scaleFactor()

Foam::scalar scaleFactor ( ) const

The scaling factor used to convert to metres.

Definition at line 136 of file blockMesh.C.

◆ points()

const Foam::pointField & points ( ) const

The points for the entire mesh.

these points have been scaled by scaleFactor

Definition at line 142 of file blockMesh.C.

◆ cells()

const Foam::cellShapeList & cells ( ) const

Return cell shapes list.

Definition at line 153 of file blockMesh.C.

◆ patches()

const Foam::faceListList & patches ( ) const

Return the patch face lists.

Definition at line 164 of file blockMesh.C.

◆ patchDicts()

Foam::PtrList< Foam::dictionary > patchDicts ( ) const

Get patch information from the topology mesh.

Definition at line 119 of file blockMesh.C.

References forAll, patchDicts, and StringStreamAllocator< StreamType >::str().

Here is the call graph for this function:

◆ patchNames()

Foam::wordList patchNames ( ) const

Return patch names.

Definition at line 175 of file blockMesh.C.

◆ numZonedBlocks()

Foam::label numZonedBlocks ( ) const

Number of blocks with specified zones.

Definition at line 193 of file blockMesh.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ verbose()

void verbose ( const bool  on = true)

Enable/disable verbose information about the progress.

Definition at line 94 of file blockMesh.C.

◆ writeTopology()

void writeTopology ( Ostream os) const

Writes edges of blockMesh in OBJ format.

Definition at line 211 of file blockMesh.C.

References Foam::constant::electromagnetic::e, and Foam::endl().

Here is the call graph for this function:

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