cyclicLduInterfaceField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2012 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::cyclicLduInterfaceField
26 
27 Description
28  Abstract base class for cyclic coupled interfaces.
29 
30 SourceFiles
31  cyclicLduInterfaceField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicLduInterfaceField_H
36 #define cyclicLduInterfaceField_H
37 
38 #include "primitiveFieldsFwd.H"
39 #include "typeInfo.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicLduInterfaceField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("cyclicLduInterfaceField");
57 
58 
59  // Constructors
60 
61  //- Construct given coupled patch
63  {}
64 
65 
66  //- Destructor
67  virtual ~cyclicLduInterfaceField();
68 
69 
70  // Member Functions
71 
72  // Access
73 
74  //- Is the transform required
75  virtual bool doTransform() const = 0;
76 
77  //- Return face transformation tensor
78  virtual const tensorField& forwardT() const = 0;
79 
80  //- Return neighbour-cell transformation tensor
81  virtual const tensorField& reverseT() const = 0;
82 
83  //- Return rank of component for transform
84  virtual int rank() const = 0;
85 
86 
87  //- Transform given patch field
88  template<class Type>
89  void transformCoupleField(Field<Type>& f) const;
90 
91  //- Transform given patch component field
93  (
94  scalarField& f,
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 (doTransform())
115  {
116  if (forwardT().size() == 1)
117  {
118  transform(f, forwardT()[0], f);
119  }
120  else
121  {
122  transform(f, forwardT(), f);
123  }
124  }
125 }
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
virtual bool doTransform() const =0
Is the transform required.
unsigned char direction
Definition: direction.H:43
virtual int rank() const =0
Return rank of component for transform.
Namespace for OpenFOAM.
void transformCoupleField(Field< Type > &f) const
Transform given patch field.
Abstract base class for cyclic coupled interfaces.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
cyclicLduInterfaceField()
Construct given coupled patch.
dimensionSet transform(const dimensionSet &)
Definition: dimensionSet.C:465
virtual const tensorField & reverseT() const =0
Return neighbour-cell transformation tensor.
TypeName("cyclicLduInterfaceField")
Runtime type information.
virtual ~cyclicLduInterfaceField()
Destructor.
virtual const tensorField & forwardT() const =0
Return face transformation tensor.