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