namedBlock Class Reference

Gives name to a block. More...

Inheritance diagram for namedBlock:
Collaboration diagram for namedBlock:

Public Member Functions

 TypeName ("name")
 Runtime type information. More...
 
 namedBlock (const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is)
 Construct from Istream setting pointsList. More...
 
virtual ~namedBlock ()
 Destructor. More...
 
- Public Member Functions inherited from word
 word ()
 Construct null. More...
 
 word (const word &)
 Copy constructor. More...
 
 word (const char *, const bool doStripInvalid=true)
 Copy constructor of character array. More...
 
 word (const char *, const size_type, const bool doStripInvalid)
 Copy constructor with a maximum number of characters. More...
 
 word (const string &, const bool doStripInvalid=true)
 Copy constructor of string. More...
 
 word (const std::string &, const bool doStripInvalid=true)
 Copy constructor of std::string. More...
 
 word (Istream &)
 Construct from Istream. More...
 
word capitalise () const
 Return the word with the first letter capitalised. More...
 
void operator= (const word &)
 
void operator= (const string &)
 
void operator= (const std::string &)
 
void operator= (const char *)
 
- Public Member Functions inherited from string
 string ()
 Construct null. More...
 
 string (const std::string &)
 Construct from std::string. More...
 
 string (const string &)
 Copy constructor. More...
 
 string (string &&)
 Move constructor. More...
 
 string (const char *)
 Construct as copy of character array. More...
 
 string (const UList< char > &)
 Construct as copy of UList of character. More...
 
 string (const char *, const size_type)
 Construct as copy of specified number of characters. More...
 
 string (const char)
 Construct from a single character. More...
 
 string (const size_type, const char)
 Construct from copies of a single character. More...
 
 string (Istream &)
 Construct from Istream. More...
 
size_type count (const char) const
 Count and return the number of a given character in the string. More...
 
bool match (const std::string &) const
 True when strings match literally. More...
 
stringreplace (const string &oldStr, const string &newStr, size_type start=0)
 In this string replace first occurrence of sub-string oldStr. More...
 
string replace (const string &oldStr, const string &newStr, size_type start=0) const
 Replace first occurrence of sub-string oldStr with newStr. More...
 
stringreplaceAll (const string &oldStr, const string &newStr, size_type start=0)
 In this string replace all occurrences of sub-string oldStr. More...
 
string replaceAll (const string &oldStr, const string &newStr, size_type start=0) const
 Replace all occurrences of sub-string oldStr with newStr. More...
 
stringexpand (const bool allowEmpty=false)
 Expand initial tildes and all occurrences of environment variables. More...
 
bool remove (const char)
 Remove all occurrences of character returning true if string changed. More...
 
string remove (const char) const
 Remove all occurrences of character and return the string. More...
 
bool removeRepeated (const char)
 Remove repeated character returning true if string changed. More...
 
string removeRepeated (const char) const
 Remove repeated character and return the string. More...
 
bool removeTrailing (const char)
 Remove trailing character returning true if string changed. More...
 
string removeTrailing (const char) const
 Return string with trailing character removed. More...
 
bool removeTrailing (const string &)
 Remove trailing string returning true if string changed. More...
 
string removeTrailing (const string &) const
 Return string with trailing string removed. More...
 
void strip (const string &)
 Strip characters from the start and end of the string. More...
 
size_type findClosing (const char, const size_type) const
 Find the closing character. Brackets counting algorithm. The. More...
 
string operator() (const size_type i, const size_type n) const
 Return the sub-string from the i-th character for n characters. More...
 
string operator() (const size_type n) const
 Return the sub-string from the first character for n characters. More...
 
void operator= (const string &)
 
void operator= (string &&)
 
template<class String >
Foam::string quotemeta (const string &str, const char quote)
 
- Public Member Functions inherited from block
 TypeName ("block")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, block, Istream,(const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is),(dict, index, vertices, edges, faces, is))
 
 block (const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is)
 Construct from components with Istream. More...
 
 block (const blockDescriptor &)
 Construct from a block definition. More...
 
 block (const block &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< blockclone () const
 Clone. More...
 
virtual ~block ()
 Destructor. More...
 
const pointFieldpoints () const
 Return the points for filling the block. More...
 
List< FixedList< label, 8 > > cells () const
 Return the cells for filling the block. More...
 
const FixedList< List< FixedList< label, 4 > >, 6 > & boundaryPatches () const
 Return the boundary patch faces for the block. More...
 
void operator= (const block &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from blockDescriptor
 blockDescriptor (const cellShape &, const pointField &vertices, const blockEdgeList &, const blockFaceList &, const Vector< label > &density, const UList< gradingDescriptors > &expand, const word &zoneName="")
 Construct from components. Optional cellSet/zone name. More...
 
 blockDescriptor (const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &, const blockFaceList &, Istream &)
 Construct from Istream. More...
 
 blockDescriptor (const blockDescriptor &)=default
 Copy construct. More...
 
const pointFieldvertices () const
 Reference to point field defining the block mesh. More...
 
const blockFaceListfaces () const
 Return reference to the list of curved faces. More...
 
const cellShapeblockShape () const
 Return the block shape. More...
 
const Vector< label > & density () const
 Return the mesh density (number of cells) in the i,j,k directions. More...
 
const wordzoneName () const
 Return the (optional) zone name. More...
 
label nPoints () const
 Return the number of points. More...
 
label nCells () const
 Return the number of cells. More...
 
const FixedList< label, 6 > & curvedFaces () const
 Curved-face labels for each block-face (-1 for flat faces) More...
 
label nCurvedFaces () const
 Number of curved faces in this block. More...
 
const pointblockPoint (const label i) const
 Return block point for local label i. More...
 
label pointLabel (const label i, const label j, const label k) const
 Vertex label offset for a particular i,j,k position. More...
 
label facePointLabel (const label facei, const label i, const label j) const
 Face vertex label offset for a particular i,j,k position. More...
 
bool vertex (const label i, const label j, const label k) const
 Return true if point i,j,k addresses a block vertex. More...
 
bool edge (const label i, const label j, const label k) const
 Return true if point i,j,k addresses a block edge. More...
 
label edgesPointsWeights (pointField(&edgePoints)[12], scalarList(&edgeWeights)[12]) const
 Calculate the points and weights for all edges. More...
 
bool flatFaceOrEdge (const label i, const label j, const label k) const
 Return true if point i,j,k addresses a block flat face or edge. More...
 
FixedList< pointField, 6 > facePoints (const pointField &points) const
 Return the list of face-points for all of the faces of the block. More...
 
void correctFacePoints (FixedList< pointField, 6 > &) const
 Correct the location of the given face-points. More...
 
void operator= (const blockDescriptor &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from word
static bool valid (char)
 Is this character valid for a word. More...
 
- Static Public Member Functions inherited from string
template<class String >
static bool valid (const string &)
 Is this string type valid? More...
 
template<class String >
static bool meta (const string &, const char quote='\\')
 Does this string have particular meta-characters? More...
 
template<class String >
static bool stripInvalid (string &)
 Strip invalid characters from the given string. More...
 
template<class String >
static String validate (const string &)
 Return a valid String from the given string. More...
 
template<class String >
static string quotemeta (const string &, const char quote='\\')
 Return a String with quoted meta-characters from the given string. More...
 
- Static Public Member Functions inherited from block
static autoPtr< blockNew (const dictionary &dict, const label index, const pointField &points, const blockEdgeList &edges, const blockFaceList &faces, Istream &)
 New function which constructs and returns pointer to a block. More...
 
- Static Public Member Functions inherited from blockDescriptor
static void write (Ostream &, const label blocki, const dictionary &)
 Write block index with dictionary lookup. More...
 
- Static Public Attributes inherited from word
static const char *const typeName = "word"
 
static int debug
 
static const word null
 An empty word. More...
 
- Static Public Attributes inherited from string
static const char *const typeName = "string"
 
static int debug
 
static const string null
 An empty string. More...
 

Detailed Description

Gives name to a block.

Source files

Definition at line 50 of file namedBlock.H.

Constructor & Destructor Documentation

◆ namedBlock()

namedBlock ( const dictionary dict,
const label  index,
const pointField vertices,
const blockEdgeList edges,
const blockFaceList faces,
Istream is 
)

Construct from Istream setting pointsList.

Definition at line 43 of file namedBlock.C.

References dictionary::add(), dict, and dictionary::subDictPtr().

Here is the call graph for this function:

◆ ~namedBlock()

virtual ~namedBlock ( )
inlinevirtual

Destructor.

Definition at line 76 of file namedBlock.H.

Member Function Documentation

◆ TypeName()

TypeName ( "name"  )

Runtime type information.


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