Gives name to a block. More...
#include <namedBlock.H>
Public Member Functions | |
| TypeNameNoDebug ("name") | |
| Runtime type information. | |
| namedBlock (const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is) | |
| Construct from Istream setting points list. | |
| virtual | ~namedBlock ()=default |
| Destructor. | |
| Public Member Functions inherited from word | |
| word ()=default | |
| Default construct. | |
| word (const word &)=default | |
| Copy construct. | |
| word (word &&w)=default | |
| Move construct. | |
| word (const string &s, bool doStrip=true) | |
| Copy construct from Foam::string. | |
| word (string &&s, bool doStrip=true) | |
| Move construct from Foam::string. | |
| word (const std::string &s, bool doStrip=true) | |
| Copy construct from std::string. | |
| word (std::string &&s, bool doStrip=true) | |
| Move construct from std::string. | |
| word (const char *s, bool doStrip=true) | |
| Copy from character array. | |
| word (const char *s, size_type len, bool doStrip) | |
| Copy from buffer for a maximum number of characters. | |
| word (Istream &is) | |
| Construct from Istream. | |
| void | stripInvalid () |
| Strip invalid characters from this word. | |
| word | ext () const |
| Return file name extension (part after last .). | |
| word & | ext (const word &ending) |
| Append a '.' and the ending, and return the object. | |
| word & | replace_ext (const word &ending) |
| Remove extension (if any) and append a new one. | |
| word | lessExt () const |
| Return word without extension (part before last .). | |
| word & | operator= (const word &s) |
| Copy assignment, no character validation required. | |
| word & | operator= (word &&s) |
| Move assignment, no character validation required. | |
| word & | operator= (const string &s) |
| Copy assignment from Foam::string, stripping invalid characters. | |
| word & | operator= (string &&s) |
| Move assignment from Foam::string, stripping invalid characters. | |
| word & | operator= (const std::string &s) |
| Copy assignment from std::string, stripping invalid characters. | |
| word & | operator= (std::string &&s) |
| Move assignment from std::string, stripping invalid characters. | |
| word & | operator= (const char *s) |
| Copy, stripping invalid characters. | |
| bool | hasExt () const |
| Same as has_ext(). | |
| bool | hasExt (const std::string &s) const |
| Same as has_ext(). | |
| bool | removeExt () |
| Same as remove_ext(). | |
| template<class PrimitiveType> | |
| Foam::word | printf (const char *fmt, const PrimitiveType &val) |
| template<class PrimitiveType> | |
| Foam::word | printf (const std::string &fmt, const PrimitiveType &val) |
| bool | remove_ext () |
| Remove extension, return true if string changed. | |
| bool | has_ext () const |
| Various checks for extensions. | |
| bool | has_ext (const char *ending) const |
| Various checks for extensions. | |
| bool | has_ext (const std::string &ending) const |
| Various checks for extensions. | |
| bool | has_ext (const wordRe &ending) const |
| Various checks for extensions. | |
| Public Member Functions inherited from string | |
| string ()=default | |
| Default construct. | |
| string (const std::string &str) | |
| Copy construct from std::string. | |
| string (std::string &&str) | |
| Move construct from std::string. | |
| string (const char *str) | |
| Construct as copy of character array. | |
| string (const char *str, const size_type len) | |
| Construct as copy with a maximum number of characters. | |
| string (const char c) | |
| Construct from a single character. | |
| string (const size_type len, const char c) | |
| Construct fill copies of a single character. | |
| string (Istream &is) | |
| Construct from Istream. | |
| bool | match (const std::string &text) const |
| Test for equality. | |
| string & | replace (const std::string &s1, const std::string &s2, size_type pos=0) |
| Replace first occurrence of sub-string s1 with s2, beginning at pos. | |
| string & | replaceAll (const std::string &s1, const std::string &s2, size_type pos=0) |
| Replace all occurrences of sub-string s1 with s2, beginning at pos in the string. | |
| string & | replaceAny (const std::string &s1, const char c2, size_type pos=0) |
| Replace any occurrence of s1 characters with c2, beginning at pos in the string. | |
| string & | expand (const bool allowEmpty=false) |
| Inplace expand initial tags, tildes, and all occurrences of environment variables as per stringOps::expand. | |
| bool | removeRepeated (const char character) |
| Remove repeated characters. | |
| bool | removeStart (const std::string &text) |
| Remove the given text from the start of the string. | |
| bool | removeStart (const char c) |
| Remove leading character, unless string is a single character. | |
| bool | removeEnd (const std::string &text) |
| Remove the given text from the end of the string. | |
| bool | removeEnd (const char c) |
| Remove trailing character, unless string is a single character. | |
| void | swap (std::string &str) |
| Swap contents. Self-swapping is a no-op. | |
| bool | operator() (const std::string &text) const |
| Test for equality. Allows use as a predicate. | |
| bool | contains (char c) const noexcept |
| True if string contains given character (cf. C++23). | |
| bool | contains (const std::string &s) const noexcept |
| True if string contains given [string view] substring (cf. C++23). | |
| bool | contains (const char *s) const |
| True if string contains given substring (cf. C++23). | |
| bool | starts_with (char c) const |
| True if string starts with given character (cf. C++20). | |
| bool | starts_with (const std::string &s) const |
| True if string starts with given [string view] prefix (C++20). | |
| bool | starts_with (const char *s) const |
| True if string starts with given prefix (C++20). | |
| bool | ends_with (char c) const |
| True if string ends with given character (cf. C++20). | |
| bool | ends_with (const std::string &s) const |
| True if string ends with given [string view] suffix (cf. C++20). | |
| bool | ends_with (const char *s) const |
| True if string ends with given suffix (cf. C++20). | |
| size_type | count (const char c) const |
| Count the number of occurrences of the specified character in the string. | |
| bool | startsWith (const std::string &s) const |
| Deprecated(2019-11). | |
| bool | endsWith (const std::string &s) const |
| Deprecated(2019-11). | |
| bool | removeTrailing (const char c) |
| Deprecated(2019-11). | |
| Public Member Functions inherited from block | |
| TypeName ("block") | |
| Runtime type information. | |
| 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 cellShape &bshape, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, const labelVector &density, const UList< gradingDescriptors > &expand=UList< gradingDescriptors >::null(), const word &zoneName="") | |
| Construct from components. Optional zone name. | |
| block (const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is) | |
| Construct from components with Istream. | |
| block (const blockDescriptor &blockDesc) | |
| Construct from a block definition. | |
| autoPtr< block > | clone () const |
| Clone. | |
| virtual | ~block ()=default |
| Destructor. | |
| const pointField & | points () const noexcept |
| The points for filling the block. | |
| const List< hexCell > & | cells () const |
| The hex cells for filling the block. | |
| const FixedList< List< FixedList< label, 4 > >, 6 > & | boundaryPatches () const noexcept |
| The boundary patch faces for the block. | |
| cellShapeList | shapes () const |
| The (hex) cell shapes for filling the block. | |
| Public Member Functions inherited from blockDescriptor | |
| blockDescriptor (const blockDescriptor &)=default | |
| Copy construct. | |
| void | operator= (const blockDescriptor &)=delete |
| No copy assignment. | |
| blockDescriptor (const cellShape &bshape, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, const labelVector &density, const UList< gradingDescriptors > &expand=UList< gradingDescriptors >::null(), const word &zoneName=word::null) | |
| Construct from components. Optional zone name. | |
| blockDescriptor (const dictionary &dict, const label blockIndex, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is) | |
| Construct from Istream. | |
| const pointField & | vertices () const noexcept |
| Reference to point field defining the block mesh. | |
| const blockFaceList & | blockFaces () const noexcept |
| Return reference to the list of curved faces. | |
| const cellShape & | blockShape () const noexcept |
| Return the block shape. | |
| const labelVector & | density () const noexcept |
| The mesh density (number of cells) in the i,j,k directions. | |
| const List< gradingDescriptors > & | grading () const noexcept |
| Expansion ratios in all directions. | |
| const word & | zoneName () const noexcept |
| Return the (optional) zone name. | |
| const FixedList< label, 6 > & | curvedFaces () const noexcept |
| Curved-face labels for each block-face (-1 for flat faces). | |
| label | nCurvedFaces () const noexcept |
| Number of curved faces in this block. | |
| const point & | blockPoint (const label i) const |
| Return block point for local label i. | |
| label | facePointLabel (const direction facei, const label i, const label j) const |
| Face vertex label offset for a particular i,j,k position on hex face (0-5). | |
| bool | vertex (const label i, const label j, const label k) const |
| True if point i,j,k addresses a block vertex. | |
| bool | edge (const label i, const label j, const label k) const |
| True if point i,j,k addresses a block edge. | |
| int | edgesPointsWeights (pointField(&edgesPoints)[12], scalarList(&edgesWeights)[12]) const |
| Calculate the points and weights for all edges. | |
| bool | edgePointsWeights (const label edgei, pointField &edgePoints, scalarList &edgeWeights, const label nDiv, const gradingDescriptors &gd=gradingDescriptors()) const |
| Calculate points and weights for specified edge, using the specified number of divisions and grading. | |
| bool | edgePointsWeights (const label edgei, pointField &edgePoints, scalarList &edgeWeights) const |
| Calculate points and weights for specified edge. | |
| 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. | |
| FixedList< pointField, 6 > | facePoints (const pointField &points) const |
| Return the list of face-points for all of the faces of the block. | |
| void | correctFacePoints (FixedList< pointField, 6 > &) const |
| Correct the location of the given face-points. | |
| InfoProxy< blockDescriptor > | info () const noexcept |
| Return info proxy, used to print information to a stream. | |
| Public Member Functions inherited from ijkMesh | |
| ijkMesh () | |
| Construct zero-sized. | |
| ijkMesh (const labelVector &ijk) | |
| Construct with addressing. | |
| ijkMesh (const label nx, const label ny, const label nz) | |
| Construct with addressing. | |
| label | nPoints () const |
| The number of mesh points (nx+1)*(ny+1)*(nz+1) in the i-j-k mesh. | |
| label | nCells () const |
| The number of mesh cells (nx*ny*nz) in the i-j-k mesh. | |
| label | nFaces () const |
| The total number of mesh faces in the i-j-k mesh. | |
| label | nInternalFaces () const |
| The number of internal faces in the i-j-k mesh. | |
| label | nBoundaryFaces () const |
| The number of boundary faces in the i-j-k mesh. | |
| label | nBoundaryFaces (const direction shapeFacei) const |
| The number of boundary faces on the box face. | |
| label | cellLabel (const label i, const label j, const label k) const |
| The linear cell index for an i-j-k position - same as index(). | |
| label | cellLabel (const labelVector &ijk) const |
| The linear cell index for an i-j-k position - same as index(). | |
| label | pointLabel (const label i, const label j, const label k) const |
| The linear point index for an i-j-k position. | |
| label | pointLabel (const labelVector &ijk) const |
| The linear point index for an i-j-k position. | |
| hexCell | vertLabels (const label i, const label j, const label k) const |
| The hex cell vertices for an i-j-k position. | |
| hexCell | vertLabels (const labelVector &ijk) const |
| The hex cell vertices for an i-j-k position. | |
| Public Member Functions inherited from ijkAddressing | |
| ijkAddressing () | |
| Construct zero-size addressing. | |
| ijkAddressing (const labelVector &ijk) | |
| Construct with addressing. | |
| ijkAddressing (const label ni, const label nj, const label nk) | |
| Construct with addressing components. | |
| bool | empty () const noexcept |
| Addressing is considered empty if any component is zero. | |
| const labelVector & | sizes () const noexcept |
| The (i,j,k) addressing dimensions. | |
| labelVector & | sizes () noexcept |
| Return the (i,j,k) dimensions for modification. | |
| label | size () const noexcept |
| Return the total i*j*k size. | |
| label | size (const vector::components cmpt) const |
| The addressing dimension in the given direction. | |
| void | clear () |
| Reset to (0,0,0) sizing. | |
| void | reset (const label ni, const label nj, const label nk) |
| Change the sizing parameters. | |
| void | reset (const labelVector &newSizes) |
| Change the sizing parameters. | |
| label | index (const label i, const label j, const label k) const |
| Linear addressing index (offset) for an (i,j,k) position. | |
| label | index (const labelVector &ijk) const |
| Linear addressing index (offset) for an (i,j,k) position. | |
| labelVector | index (const label idx) const |
| The (i,j,k) indexing from linear addressing. | |
| void | checkIndex (const label i, const label j, const label k, const bool allowExtra=false) const |
| Check indices are within ni,nj,nk range. | |
| void | checkIndex (const labelVector &ijk, const bool allowExtra=false) const |
| Check indices are within ni,nj,nk range. | |
| void | checkSizes () const |
| Check that all components of sizes() are non-negative. | |
| void | checkSizes (const labelVector &other) const |
| Check that all components of sizes() match. | |
| void | checkSizes (const label nTotal) const |
| Check that the total size matches. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from word | |
| template<class PrimitiveType> | |
| static word | printf (const char *fmt, const PrimitiveType &val) |
| Use a printf-style formatter for a primitive. | |
| template<class PrimitiveType> | |
| static word | printf (const std::string &fmt, const PrimitiveType &val) |
| Use a printf-style formatter for a primitive. | |
| static bool | valid (char c) |
| Is this character valid for a word? | |
| static word | validate (const std::string &s, const bool prefix=false) |
| Construct validated word (no invalid characters). | |
| static word | validate (const char *first, const char *last, const bool prefix=false) |
| Construct validated word (no invalid characters) from a sequence of characters in the range [first,last),. | |
| Static Public Member Functions inherited from string | |
| static std::string::size_type | length (const char *s) |
| Length of the character sequence (with nullptr protection). | |
| static std::string::size_type | length (const std::string &s) |
| The length of the string. | |
| template<class StringType> | |
| static bool | valid (const std::string &str) |
| Does the string contain valid characters only? | |
| template<class StringType> | |
| static bool | stripInvalid (std::string &str) |
| Strip invalid characters from the given string. | |
| template<class StringType> | |
| static StringType | validate (const std::string &str) |
| Return a valid String from the given string. | |
| Static Public Member Functions inherited from block | |
| static autoPtr< block > | New (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. | |
| Static Public Member Functions inherited from blockDescriptor | |
| static void | write (Ostream &, const label blocki, const dictionary &) |
| Write block index with dictionary lookup. | |
| Static Public Attributes inherited from word | |
| static const char *const | typeName = "word" |
| The typeName. | |
| static int | debug |
| Debugging. | |
| static const word | null |
| An empty word. | |
| Static Public Attributes inherited from string | |
| static const char *const | typeName = "string" |
| The type name "string". | |
| static int | debug |
| The debug flag. | |
| static const string | null |
| An empty string. | |
| Protected Member Functions inherited from string | |
| std::string::size_type | find_ext () const |
| Find position of a file extension dot, return npos on failure. | |
| word | ext () const |
| Return file name extension (part after last .). | |
| bool | ext (const word &ending) |
| Append a '.' and the ending. | |
| bool | has_ext () const |
| Return true if it has an extension or simply ends with a '.'. | |
| bool | has_ext (const char *ending) const |
| Return true if the extension is the same as the given ending. | |
| bool | has_ext (const std::string &ending) const |
| Return true if the extension is the same as the given ending. | |
| bool | has_ext (const wordRe &ending) const |
| Return true if the extension matches the given ending. | |
| bool | remove_path () |
| Remove leading path, return true if string changed. | |
| bool | remove_ext () |
| Remove extension, return true if string changed. | |
| Static Protected Member Functions inherited from string | |
| static std::string::size_type | find_ext (const std::string &str) |
| Find position of a file extension dot, return npos on failure. | |
| template<class PrimitiveType> | |
| static std::string::size_type | string_printf (std::string &output, const char *fmt, const PrimitiveType &val) |
| A printf-style formatter for a primitive. | |
| template<class PrimitiveType> | |
| static std::string::size_type | string_printf (std::string &output, const std::string &fmt, const PrimitiveType &val) |
| A printf-style formatter for a primitive. | |
| namedBlock | ( | const dictionary & | dict, |
| const label | index, | ||
| const pointField & | vertices, | ||
| const blockEdgeList & | edges, | ||
| const blockFaceList & | faces, | ||
| Istream & | is ) |
Construct from Istream setting points list.
Definition at line 39 of file namedBlock.C.
References dictionary::add(), dict, dictionary::findDict(), ijkAddressing::index(), blockDescriptor::vertices(), and word::word().
|
virtualdefault |
Destructor.
| TypeNameNoDebug | ( | "name" | ) |
Runtime type information.
References dict, ijkAddressing::index(), and blockDescriptor::vertices().
1.16.1 