midPoint.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::midPoint
26 
27 Description
28  Mid-point interpolation (weighting factors = 0.5) scheme class.
29 
30 SourceFiles
31  midPoint.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef midPoint_H
36 #define midPoint_H
37 
39 #include "volFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class midPoint Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class midPoint
52 :
53  public surfaceInterpolationScheme<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("midPoint");
60 
61 
62  // Constructors
63 
64  //- Construct from mesh
65  midPoint(const fvMesh& mesh)
66  :
67  surfaceInterpolationScheme<Type>(mesh)
68  {}
69 
70  //- Construct from Istream
71  midPoint(const fvMesh& mesh, Istream&)
72  :
73  surfaceInterpolationScheme<Type>(mesh)
74  {}
75 
76  //- Construct from faceFlux and Istream
78  (
79  const fvMesh& mesh,
80  const surfaceScalarField&,
81  Istream&
82  )
83  :
84  surfaceInterpolationScheme<Type>(mesh)
85  {}
86 
87 
88  // Member Functions
89 
90  //- Return the interpolation weighting factors
92  (
94  ) const
95  {
97  (
99  (
100  "midPointWeights",
101  this->mesh(),
103  )
104  );
105 
106  surfaceScalarField::Boundary& awBf =
107  taw.ref().boundaryFieldRef();
108 
109  forAll(awBf, patchi)
110  {
111  if (!awBf[patchi].coupled())
112  {
113  awBf[patchi] = 1.0;
114  }
115  }
116 
117  return taw;
118  }
119 
120 
121  // Member Operators
122 
123  //- Disallow default bitwise assignment
124  void operator=(const midPoint&) = delete;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
tmp< surfaceScalarField > weights(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the interpolation weighting factors.
Definition: midPoint.H:91
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
static tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > New(const word &name, const Internal &, const PtrList< fvsPatchField< scalar >> &)
Return a temporary field constructed from name,.
const dimensionSet dimless
const fvMesh & mesh() const
Return mesh reference.
midPoint(const fvMesh &mesh)
Construct from mesh.
Definition: midPoint.H:64
TypeName("midPoint")
Runtime type information.
Mid-point interpolation (weighting factors = 0.5) scheme class.
Definition: midPoint.H:50
void operator=(const midPoint &)=delete
Disallow default bitwise assignment.
label patchi
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
Abstract base class for surface interpolation schemes.
Namespace for OpenFOAM.