All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
jumpCyclicAMIFvPatchField.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) 2012-2019 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::jumpCyclicAMIFvPatchField
26 
27 Description
28  This boundary condition provides a base class that enforces a cyclic
29  condition with a specified 'jump' (or offset) between a pair of boundaries,
30  whereby communication between the patches is performed using an arbitrary
31  mesh interface (AMI) interpolation.
32 
33 See also
34  Foam::cyclicAMIFvPatchField
35 
36 SourceFiles
37  jumpCyclicAMIFvPatchField.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef jumpCyclicAMIFvPatchField_H
42 #define jumpCyclicAMIFvPatchField_H
43 
44 #include "cyclicAMIFvPatchField.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class jumpCyclicAMIFvPatchField Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
57 :
58  public cyclicAMIFvPatchField<Type>
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("jumpCyclicAMI");
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const fvPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const fvPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping given jumpCyclicAMIFvPatchField onto a
85  // new patch
87  (
89  const fvPatch&,
91  const fvPatchFieldMapper&
92  );
93 
94  //- Copy constructor
96  (
98  );
99 
100  //- Copy constructor setting internal field reference
102  (
105  );
106 
107 
108  // Member Functions
109 
110  // Access
111 
112  //- Return the interface type
113  virtual const word& interfaceFieldType() const
114  {
116  }
117 
118  //- Return the "jump" across the patch as a "half" field
119  virtual tmp<Field<Type>> jump() const = 0;
120 
121 
122  // Evaluation functions
123 
124  //- Return neighbour coupled given internal cell data
126 
127  //- Update result field based on interface functionality
128  virtual void updateInterfaceMatrix
129  (
130  scalarField& result,
131  const scalarField& psiInternal,
132  const scalarField& coeffs,
133  const direction cmpt,
134  const Pstream::commsTypes commsType
135  ) const;
136 
137  //- Update result field based on interface functionality
138  virtual void updateInterfaceMatrix
139  (
140  Field<Type>&,
141  const Field<Type>&,
142  const scalarField&,
143  const Pstream::commsTypes commsType
144  ) const;
145 };
146 
147 
148 //- Update result field based on interface functionality
149 template<>
151 (
152  scalarField& result,
153  const scalarField& psiInternal,
154  const scalarField& coeffs,
155  const direction cmpt,
156  const Pstream::commsTypes commsType
157 ) const;
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #ifdef NoRepository
167  #include "jumpCyclicAMIFvPatchField.C"
168 #endif
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
This boundary condition provides a base class that enforces a cyclic condition with a specified &#39;jump...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
commsTypes
Types of communications.
Definition: UPstream.H:64
uint8_t direction
Definition: direction.H:45
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
jumpCyclicAMIFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
tmp< Field< Type > > patchNeighbourField() const
Return neighbour coupled given internal cell data.
TypeName("jumpCyclicAMI")
Runtime type information.
virtual void updateInterfaceMatrix(scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
Update result field based on interface functionality.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
virtual const word & interfaceFieldType() const
Return the interface type.
virtual tmp< Field< Type > > jump() const =0
Return the "jump" across the patch as a "half" field.
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communicati...
Namespace for OpenFOAM.