nonConformalProcessorCyclicLagrangianPatchField.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) 2025 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::nonConformalProcessorCyclicLagrangianPatchField
26 
27 Description
28  A non-conformal cyclic boundary condition for Lagrangian. Properties are
29  transformed by the transformation of the associated non-conformal cyclic
30  patch.
31 
32 Usage
33  Example specification:
34  \verbatim
35  <LagrangianPatchName>
36  {
37  type nonConformalProcessorCyclic;
38  }
39  \endverbatim
40 
41 SourceFiles
42  nonConformalProcessorCyclicLagrangianPatchField.C
43 
44 \*---------------------------------------------------------------------------*/
45 
46 #ifndef nonConformalProcessorCyclicLagrangianPatchField_H
47 #define nonConformalProcessorCyclicLagrangianPatchField_H
48 
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class nonConformalProcessorCyclicLagrangianPatchField Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 template<class Type>
63 :
65 {
66 private:
67 
68  // Private Data
69 
70  //- Reference to the nonConformalProcessorCyclic patch
72  nonConformalProcessorCyclicPatch_;
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("nonConformalProcessorCyclic");
79 
80 
81  // Constructors
82 
83  //- Construct from patch and internal field
85  (
86  const LagrangianPatch&,
87  const regIOobject&
88  );
89 
90  //- Construct from patch, internal field and dictionary
92  (
93  const LagrangianPatch&,
94  const regIOobject&,
95  const dictionary&
96  );
97 
98  //- Construct as copy
100  (
102  );
103 
104  //- Construct as copy setting the internal field reference
106  (
108  const regIOobject&
109  );
110 
111  //- Construct as copy setting the patch and the internal field reference
113  (
115  const LagrangianPatch&,
116  const regIOobject&
117  );
118 
119  //- Construct and return a clone
121  {
123  (
125  (
126  *this
127  )
128  );
129  }
130 
131  //- Construct and return a clone setting the internal field reference
133  (
134  const regIOobject& iIo
135  ) const
136  {
138  (
140  (
141  *this,
142  iIo
143  )
144  );
145  }
146 
147  //- Construct and return a clone onto a new patch
148  // and setting the internal field reference
150  (
151  const LagrangianPatch& p,
152  const regIOobject& iIo
153  ) const
154  {
156  (
158  (
159  *this,
160  p,
161  iIo
162  )
163  );
164  }
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #ifdef NoRepository
176 #endif
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 #endif
181 
182 // ************************************************************************* //
Base class for Lagrangian patches.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A non-conformal cyclic boundary condition for Lagrangian. Properties are transformed by the transform...
virtual autoPtr< LagrangianPatchField< Type > > clone() const
Construct and return a clone.
TypeName("nonConformalProcessorCyclic")
Runtime type information.
nonConformalProcessorCyclicLagrangianPatchField(const LagrangianPatch &, const regIOobject &)
Construct from patch and internal field.
A processorCyclic boundary condition for Lagrangian. Properties are communicated to and from the neig...
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:55
Namespace for OpenFOAM.
volScalarField & p