nonConformalProcessorCyclicFvPatch.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) 2011-2022 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::nonConformalProcessorCyclicFvPatch
26 
27 Description
28  Non-conformal processor cyclic FV patch. As nonConformalCyclicFvPatch,
29  but the neighbouring patch is on a different processor.
30 
31 See also
32  Foam::nonConformalProcessorCyclicPolyPatch
33  Foam::nonConformalCyclicFvPatch
34 
35 SourceFiles
36  nonConformalProcessorCyclicFvPatch.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef nonConformalProcessorCyclicFvPatch_H
41 #define nonConformalProcessorCyclicFvPatch_H
42 
43 #include "processorCyclicFvPatch.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class nonConformalProcessorCyclicFvPatch Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
60 {
61  // Private Data
62 
63  //- Reference to the polyPatch
65  nonConformalProcessorCyclicPolyPatch_;
66 
67 
68 protected:
69 
70  // Protected Member functions
71 
72  //- Make patch weighting factors
73  virtual void makeWeights(scalarField& w) const;
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName(nonConformalProcessorCyclicPolyPatch::typeName_());
80 
81 
82  // Constructors
83 
84  //- Construct from components
86  (
87  const polyPatch& patch,
88  const fvBoundaryMesh& bm
89  );
90 
91 
92  //- Destructor
94 
95 
96  // Member Functions
97 
98  // Access
99 
100  //- Poly patch
103 
104  //- ...
106 
107  //- ...
109 
110  //- ...
112 
113  //- Is this patch coupled? Returns true. For NCC patches the poly
114  // mesh is considered non-coupled whilst the finite volume mesh is
115  // considered coupled.
116  virtual bool coupled() const;
117 
118  //- Return the start label of this patch in the polyMesh face list.
119  // Raises an error unless the patch is empty.
120  virtual label start() const;
121 
122  //- Return the size
123  virtual label size() const;
124 
125  //- Return the face-cells
126  virtual const labelUList& faceCells() const;
127 
128 
129  //- Return delta (P to N) vectors across coupled patch
130  virtual tmp<vectorField> delta() const;
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
virtual bool owner() const
Does this side own the patch ?
virtual bool coupled() const
Is this patch coupled? Returns true. For NCC patches the poly.
virtual void makeWeights(scalarField &w) const
Make patch weighting factors.
Non-conformal processor cyclic FV patch. As nonConformalCyclicFvPatch, but the neighbouring patch is ...
virtual const labelUList & faceCells() const
Return the face-cells.
TypeName(nonConformalProcessorCyclicPolyPatch::typeName_())
Runtime type information.
Non-conformal processor cyclic poly patch. As nonConformalCyclicPolyPatch, but the neighbouring patch...
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:139
virtual label start() const
Return the start label of this patch in the polyMesh face list.
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:60
Non-conformal coupled FV patch. As nonConformalFvPatch, but is also coupled to another non-conformal ...
nonConformalProcessorCyclicFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from components.
Foam::fvBoundaryMesh.
virtual const transformer & transform() const
Return transformation between the coupled patches.
virtual bool neighbour() const
Does the coupled side own the patch ?
virtual tmp< vectorField > delta() const
Return delta (P to N) vectors across coupled patch.
A class for managing temporary objects.
Definition: PtrList.H:53
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
const nonConformalProcessorCyclicPolyPatch & nonConformalProcessorCyclicPatch() const
Poly patch.
Namespace for OpenFOAM.