Public Member Functions | List of all members
blockMesh Class Reference

A multi-block mesh generator. More...

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

Public Member Functions

 ClassName ("blockMesh")
 
 blockMesh (const IOdictionary &, const word &regionName)
 Construct from IOdictionary. 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 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 >
 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 (const Xfer< PtrList< T >> &)
 Construct by transferring the parameter contents. 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...
 
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container. 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 &)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< T > &)
 Assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (const Xfer< UPtrList< T >> &)
 Construct by transferring the parameter contents. 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...
 
Xfer< UPtrList< T > > xfer ()
 Transfer contents to the Xfer container. 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 &)
 Reorders elements. Ordering does not have to be done in. 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...
 
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...
 

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 61 of file blockMesh.H.

Constructor & Destructor Documentation

◆ blockMesh()

blockMesh ( const IOdictionary dict,
const word regionName 
)

Construct from IOdictionary.

Definition at line 39 of file blockMesh.C.

References dictionary::lookupOrDefault().

Here is the call graph for this function:

◆ ~blockMesh()

~blockMesh ( )

Destructor.

Definition at line 83 of file blockMesh.C.

Member Function Documentation

◆ ClassName()

ClassName ( "blockMesh"  )

◆ meshDict()

const dictionary& meshDict ( ) const
inline

Access to input dictionary.

Definition at line 184 of file blockMesh.H.

◆ geometry()

const searchableSurfaces& geometry ( ) const
inline

Optional searchable geometry to project face-points to.

Definition at line 190 of file blockMesh.H.

References blockMesh::topology(), and blockMesh::vertices().

Here is the call graph for this function:

◆ vertices()

const Foam::pointField & vertices ( ) const

Reference to point field defining the blockMesh.

these points have not been scaled by scaleFactor

Definition at line 97 of file blockMesh.C.

Referenced by blockMesh::geometry().

Here is the caller graph for this function:

◆ topology()

const Foam::polyMesh & topology ( ) const

Return the blockMesh topology as a polyMesh.

Definition at line 103 of file blockMesh.C.

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

Referenced by blockMesh::geometry(), blockMesh::patchDicts(), blockMesh::patchNames(), and blockMesh::writeTopology().

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

◆ edges()

const blockEdgeList& edges ( ) const
inline

Return the curved edges.

Definition at line 203 of file blockMesh.H.

Referenced by blockMesh::writeTopology().

Here is the caller graph for this function:

◆ faces()

const blockFaceList& faces ( ) const
inline

◆ scaleFactor()

Foam::scalar scaleFactor ( ) const

The scaling factor used to convert to metres.

Definition at line 133 of file blockMesh.C.

Referenced by blockMesh::faces().

Here is the caller graph for this function:

◆ points()

const Foam::pointField & points ( ) const

The points for the entire mesh.

these points have been scaled by scaleFactor

Definition at line 139 of file blockMesh.C.

References UList< T >::empty().

Referenced by blockMesh::faces().

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

◆ cells()

const Foam::cellShapeList & cells ( ) const

Return cell shapes list.

Definition at line 150 of file blockMesh.C.

References UList< T >::empty().

Referenced by blockMesh::faces().

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

◆ patches()

const Foam::faceListList & patches ( ) const

Return the patch face lists.

Definition at line 161 of file blockMesh.C.

References UList< T >::empty().

Referenced by blockMesh::faces().

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

◆ patchDicts()

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

Get patch information from the topology mesh.

Definition at line 116 of file blockMesh.C.

References polyMesh::boundaryMesh(), forAll, patchi, UPtrList< T >::size(), OStringStream::str(), and blockMesh::topology().

Referenced by blockMesh::faces().

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

◆ patchNames()

Foam::wordList patchNames ( ) const

Return patch names.

Definition at line 172 of file blockMesh.C.

References polyMesh::boundaryMesh(), polyBoundaryMesh::names(), and blockMesh::topology().

Referenced by blockMesh::faces().

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

◆ numZonedBlocks()

Foam::label numZonedBlocks ( ) const

Number of blocks with specified zones.

Definition at line 190 of file blockMesh.C.

References forAll, and UPtrList< T >::size().

Referenced by blockMesh::faces().

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

◆ verbose()

void verbose ( const bool  on = true)

Enable/disable verbose information about the progress.

Definition at line 91 of file blockMesh.C.

Referenced by blockMesh::faces().

Here is the caller graph for this function:

◆ writeTopology()

void writeTopology ( Ostream os) const

Writes edges of blockMesh in OBJ format.

Definition at line 206 of file blockMesh.C.

References Foam::e, blockMesh::edges(), primitiveMesh::edges(), edge::end(), Foam::endl(), forAll, polyMesh::points(), edge::start(), blockMesh::topology(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by blockMesh::faces().

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

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