namedBlock.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::blocks::namedBlock
26 
27 Description
28  Gives name to a block.
29 
30 SourceFiles
31  namedBlock.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef blocks_namedBlock_H
36 #define blocks_namedBlock_H
37 
38 #include "block.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace blocks
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class namedBlock Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class namedBlock
52 :
53  public word,
54  public block
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("name");
60 
61 
62  // Constructors
63 
64  //- Construct from Istream setting pointsList
66  (
67  const dictionary& dict,
68  const label index,
69  const pointField& vertices,
70  const blockEdgeList& edges,
71  const blockFaceList& faces,
72  Istream& is
73  );
74 
75 
76  //- Destructor
77  virtual ~namedBlock()
78  {}
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace blocks
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #endif
90 
91 // ************************************************************************* //
dictionary dict
TypeName("name")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Gives name to a block.
Definition: namedBlock.H:50
namedBlock(const dictionary &dict, const label index, const pointField &vertices, const blockEdgeList &edges, const blockFaceList &faces, Istream &is)
Construct from Istream setting pointsList.
Definition: namedBlock.C:44
A class for handling words, derived from string.
Definition: word.H:59
Creates a single block of cells from point coordinates, numbers of cells in each direction and an exp...
Definition: block.H:63
const pointField & vertices() const
Reference to point field defining the block mesh.
virtual ~namedBlock()
Destructor.
Definition: namedBlock.H:76
const blockFaceList & faces() const
Return reference to the list of curved faces.
Namespace for OpenFOAM.