patchInteractionDataList.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) 2011 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::patchInteractionDataList
28
29Description
30 List container for patchInteractionData class
31
32\*---------------------------------------------------------------------------*/
33
34#ifndef patchInteractionDataList_H
35#define patchInteractionDataList_H
36
38#include "polyMesh.H"
39#include "dictionary.H"
40#include "labelList.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46/*---------------------------------------------------------------------------*\
47 Class patchInteractionDataList Declaration
48\*---------------------------------------------------------------------------*/
51:
52 public List<patchInteractionData>
53{
54private:
55
56 // Private data
57
58 //- List of patch IDs for each patch group
59 labelListList patchGroupIDs_;
60
61
62public:
63
64 // Constructor
65
66 //- Construct null
68
69 //- Construct copy
71
72 //- Construct from Istream
74
75
76 // Member functions
77
78 //- Return label of group containing patch id
79 // Returns -1 if patch id is not present
80 label applyToPatch(const label id) const;
81};
82
83
84// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85
86} // End namespace Foam
87
88// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89
90#endif
91
92// ************************************************************************* //
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:77
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
List container for patchInteractionData class.
label applyToPatch(const label id) const
Return label of group containing patch id.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
dynamicFvMesh & mesh
Namespace for OpenFOAM.
dictionary dict