cyclicAMILduInterfaceField.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-2020 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::cyclicAMILduInterfaceField
26 
27 Description
28  Abstract base class for cyclic AMI coupled interfaces
29 
30 SourceFiles
31  cyclicAMILduInterfaceField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicAMILduInterfaceField_H
36 #define cyclicAMILduInterfaceField_H
37 
38 #include "primitiveFieldsFwd.H"
39 #include "transformer.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicAMILduInterfaceField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("cyclicAMILduInterfaceField");
57 
58 
59  // Constructors
60 
61  //- Construct null
63  {}
64 
65 
66  //- Destructor
68 
69 
70  // Member Functions
71 
72  // Access
73 
74  //- Return transformation between the coupled patches
75  virtual const transformer& transform() const = 0;
76 
77  //- Return rank of component for transform
78  virtual int rank() const = 0;
79 
80  //- Is the transform required
81  bool transforms() const
82  {
83  return transform().transforms() && rank() != 0;
84  }
85 
86 
87  //- Transform given patch field
88  template<class Type>
89  void transformCoupleField(Field<Type>& f) const;
90 
91  //- Transform given patch internal field
93  (
94  scalarField& psiInternal,
95  const direction cmpt
96  ) const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #include "tensorField.H"
107 
108 template<class Type>
110 (
111  Field<Type>& f
112 ) const
113 {
114  if (transforms())
115  {
116  transform().transform(f, f);
117  }
118 }
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
Vector-tensor class used to perform translations, rotations and scaling operations in 3D space...
Definition: transformer.H:83
bool transforms() const
Return true if the transformer transforms a type.
Definition: transformerI.H:133
TypeName("cyclicAMILduInterfaceField")
Runtime type information.
uint8_t direction
Definition: direction.H:45
virtual const transformer & transform() const =0
Return transformation between the coupled patches.
Abstract base class for cyclic AMI coupled interfaces.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
Pre-declare SubField and related Field type.
Definition: Field.H:56
void transformCoupleField(Field< Type > &f) const
Transform given patch field.
virtual int rank() const =0
Return rank of component for transform.
Type transform(const Type &) const
Transform the given type.
bool transforms() const
Is the transform required.
Namespace for OpenFOAM.