localMax.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::localMax
26 
27 Description
28  LocalMax-mean differencing scheme class.
29 
30  This scheme interpolates 1/field using a scheme specified at run-time
31  and return the reciprocal of the interpolate.
32 
33 SourceFiles
34  localMax.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef localMax_H
39 #define localMax_H
40 
42 #include "volFields.H"
43 #include "surfaceFields.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class localMax Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class Type>
55 class localMax
56 :
57  public surfaceInterpolationScheme<Type>
58 {
59  // Private Member Functions
60 
61  //- Disallow default bitwise assignment
62  void operator=(const localMax&) = delete;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("localMax");
69 
70 
71  // Constructors
72 
73  //- Construct from mesh
74  localMax(const fvMesh& mesh)
75  :
76  surfaceInterpolationScheme<Type>(mesh)
77  {}
78 
79  //- Construct from Istream.
80  // The name of the flux field is read from the Istream and looked-up
81  // from the mesh objectRegistry
83  (
84  const fvMesh& mesh,
85  Istream& is
86  )
87  :
88  surfaceInterpolationScheme<Type>(mesh)
89  {}
90 
91  //- Construct from faceFlux and Istream
93  (
94  const fvMesh& mesh,
95  const surfaceScalarField& faceFlux,
96  Istream& is
97  )
98  :
99  surfaceInterpolationScheme<Type>(mesh)
100  {}
101 
102 
103  // Member Functions
104 
105  //- Return the interpolation weighting factors
107  (
109  ) const
110  {
112 
113  return tmp<surfaceScalarField>(nullptr);
114  }
115 
116  //- Return the face-interpolate of the given cell field
119  (
121  ) const
122  {
123  const fvMesh& mesh = vf.mesh();
124 
126  (
128  (
129  "localMax::interpolate(" + vf.name() + ')',
130  mesh,
131  vf.dimensions()
132  )
133  );
135 
136  const labelUList& own = mesh.owner();
137  const labelUList& nei = mesh.neighbour();
138 
139  forAll(vff, facei)
140  {
141  vff[facei] = max(vf[own[facei]], vf[nei[facei]]);
142  }
143 
145  Boundary& bff = vff.boundaryFieldRef();
146 
147  forAll(bff, patchi)
148  {
149  const fvPatchField<Type>& pf = vf.boundaryField()[patchi];
150  Field<Type>& pff = bff[patchi];
151 
152  if (pf.coupled())
153  {
155  const Field<Type>& pif = tpif();
156 
158  const Field<Type>& pnf = tpnf();
159 
160  forAll(pff, i)
161  {
162  pff[i] = max(pif[i], pnf[i]);
163  }
164  }
165  else
166  {
167  pff = pf;
168  }
169  }
170 
171  return tvff;
172  }
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
Foam::surfaceFields.
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
const word & name() const
Return name.
Definition: IOobject.H:303
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
const Boundary & boundaryField() const
Return const-reference to the boundary field.
T & ref() const
Return non-const reference or generate a fatal error.
Definition: tmpI.H:181
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
LocalMax-mean differencing scheme class.
Definition: localMax.H:54
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &vf) const
Return the face-interpolate of the given cell field.
Definition: localMax.H:118
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
const fvMesh & mesh() const
Return mesh reference.
const labelUList & neighbour() const
Internal face neighbour.
Definition: fvMesh.H:284
TypeName("localMax")
Runtime type information.
virtual tmp< surfaceScalarField > weights(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the interpolation weighting factors.
Definition: localMax.H:106
const dimensionSet & dimensions() const
Return dimensions.
Pre-declare SubField and related Field type.
Definition: Field.H:56
virtual tmp< Field< Type > > patchNeighbourField() const
Return patchField on the opposite patch of a coupled patch.
Definition: fvPatchField.H:411
virtual bool coupled() const
Return true if this patch field is coupled.
Definition: fvPatchField.H:309
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
localMax(const fvMesh &mesh)
Construct from mesh.
Definition: localMax.H:73
virtual tmp< Field< Type > > patchInternalField() const
Return internal field next to patch as patch field.
Definition: fvPatchField.C:174
const Mesh & mesh() const
Return mesh.
const labelUList & owner() const
Internal face owner.
Definition: fvMesh.H:278
label patchi
Boundary & boundaryFieldRef()
Return a reference to the boundary field.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:370
Abstract base class for surface interpolation schemes.
Namespace for OpenFOAM.