nonConformalCyclicFvPatch.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) 2021-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::nonConformalCyclicFvPatch
26 
27 Description
28  Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the
29  neighbouring patch is local and known and is made available by this class.
30 
31 See also
32  Foam::nonConformalCyclicPolyPatch
33  Foam::nonConformalCoupledFvPatch
34 
35 SourceFiles
36  nonConformalCyclicFvPatch.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef nonConformalCyclicFvPatch_H
41 #define nonConformalCyclicFvPatch_H
42 
43 #include "cyclicFvPatch.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 class nonConformalErrorFvPatch;
53 
54 /*---------------------------------------------------------------------------*\
55  Class nonConformalCyclicFvPatch Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public cyclicFvPatch,
62 {
63  // Private Data
64 
65  //- Reference to the polyPatch
66  const nonConformalCyclicPolyPatch& nonConformalCyclicPolyPatch_;
67 
68 
69 protected:
70 
71  // Protected Member functions
72 
73  //- Make patch weighting factors
74  void makeWeights(scalarField&) const;
75 
76 
77 public:
78 
79  //- Runtime type information
80  TypeName(nonConformalCyclicPolyPatch::typeName_());
81 
82 
83  // Constructors
84 
85  //- Construct from polyPatch and fvBoundaryMesh
87  (
88  const polyPatch& patch,
89  const fvBoundaryMesh& bm
90  );
91 
92 
93  //- Destructor
95 
96 
97  // Member Functions
98 
99  // Access
100 
101  //- Poly patch
103 
104  //- Neighbour patch
105  const nonConformalCyclicFvPatch& nbrPatch() const;
106 
107  //- ...
108  using cyclicFvPatch::owner;
109 
110  //- ...
112 
113  //- ...
115 
116  //- Is this patch coupled? Returns true. For NCC patches the poly
117  // mesh is considered non-coupled whilst the finite volume mesh is
118  // considered coupled.
119  virtual bool coupled() const;
120 
121  //- Return the start label of this patch in the polyMesh face list.
122  // Raises an error unless the patch is empty.
123  virtual label start() const;
124 
125  //- Return the size
126  virtual label size() const;
127 
128  //- Return the face-cells
129  virtual const labelUList& faceCells() const;
130 
131 
132  //- Return delta (P to N) vectors across coupled patch
133  virtual tmp<vectorField> delta() const;
134 };
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace Foam
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************************************************************* //
virtual label size() const
Return the size.
void makeWeights(scalarField &) const
Make patch weighting factors.
virtual tmp< vectorField > delta() const
Return delta (P to N) vectors across coupled patch.
virtual label start() const
Return the start label of this patch in the polyMesh face list.
virtual const labelUList & faceCells() const
Return the face-cells.
virtual ~nonConformalCyclicFvPatch()
Destructor.
virtual const transformer & transform() const
Return transformation between the coupled patches.
Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the neighbouring patch is local and...
nonConformalCyclicFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from polyPatch and fvBoundaryMesh.
virtual bool coupled() const
Is this patch coupled? Returns true. For NCC patches the poly.
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:139
TypeName(nonConformalCyclicPolyPatch::typeName_())
Runtime type information.
const nonConformalCyclicPolyPatch & nonConformalCyclicPatch() const
Poly patch.
Cyclic-plane patch.
Definition: cyclicFvPatch.H:51
Non-conformal cyclic poly patch. As nonConformalCoupledPolyPatch, but the neighbouring patch is local...
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
const nonConformalCyclicFvPatch & nbrPatch() const
Neighbour patch.
Non-conformal coupled FV patch. As nonConformalFvPatch, but is also coupled to another non-conformal ...
virtual bool owner() const
Does this side own the patch ?
Foam::fvBoundaryMesh.
virtual bool neighbour() const
Does the coupled side own the 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
Namespace for OpenFOAM.