basicSymmetryFaPatchField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2017 Wikki Ltd
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::basicSymmetryFaPatchField
28 
29 Description
30  A symmetry patch
31 
32 Author
33  Zeljko Tukovic, FMENA
34  Hrvoje Jasak, Wikki Ltd.
35 
36 SourceFiles
37  basicSymmetryFaPatchField.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef basicSymmetryFaPatchField_H
42 #define basicSymmetryFaPatchField_H
43 
44 #include "transformFaPatchField.H"
45 #include "symmetryFaPatch.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class basicSymmetryFaPatchField Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Type>
58 :
59  public transformFaPatchField<Type>
60 {
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from patch and internal field
68  (
69  const faPatch&,
71  );
72 
73  //- Construct from patch, internal field and dictionary
75  (
76  const faPatch&,
78  const dictionary&
79  );
80 
81  //- Construct by mapping given basicSymmetryFaPatchField onto a new patch
83  (
85  const faPatch&,
87  const faPatchFieldMapper&
88  );
89 
90  //- Construct as copy
92  (
94  );
95 
96  //- Construct and return a clone
97  virtual tmp<faPatchField<Type>> clone() const
98  {
100  (
102  );
103  }
104 
105  //- Construct as copy setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
118  return tmp<faPatchField<Type>>
119  (
120  new basicSymmetryFaPatchField<Type>(*this, iF)
121  );
122  }
123 
124 
125  // Member functions
126 
127  // Evaluation functions
128 
129  //- Return gradient at boundary
130  virtual tmp<Field<Type>> snGrad() const;
131 
132  //- Evaluate the patch field
133  // Default argument needed to allow call in constructors
134  // HJ, 30/Jun/2009
135  virtual void evaluate
136  (
138  );
139 
140  //- Return face-gradient transform diagonal
141  virtual tmp<Field<Type>> snGradTransformDiag() const;
142 };
143 
144 
145 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
146 
147 template<>
148 tmp<scalarField> basicSymmetryFaPatchField<scalar>::snGrad() const;
149 
150 template<>
152 (
153  const Pstream::commsTypes commsType
154 );
155 
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 } // End namespace Foam
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 #ifdef NoRepository
164  #include "basicSymmetryFaPatchField.C"
165 #endif
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 #endif
170 
171 // ************************************************************************* //
Foam::UPstream::commsTypes::blocking
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::basicSymmetryFaPatchField::clone
virtual tmp< faPatchField< Type > > clone() const
Construct and return a clone.
Definition: basicSymmetryFaPatchField.H:96
Foam::basicSymmetryFaPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Definition: basicSymmetryFaPatchField.C:109
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:44
symmetryFaPatch.H
transformFaPatchField.H
Foam::basicSymmetryFaPatchField::snGrad
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
Definition: basicSymmetryFaPatchField.C:96
Foam::basicSymmetryFaPatchField
A symmetry patch.
Definition: basicSymmetryFaPatchField.H:56
Foam::basicSymmetryFaPatchField::snGradTransformDiag
virtual tmp< Field< Type > > snGradTransformDiag() const
Return face-gradient transform diagonal.
Definition: basicSymmetryFaPatchField.C:131
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
basicSymmetryFaPatchField.C
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:66
Foam::basicSymmetryFaPatchField::basicSymmetryFaPatchField
basicSymmetryFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
Definition: basicSymmetryFaPatchField.C:35
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:65
Foam::transformFaPatchField
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition: transformFaPatchField.H:55
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54