basicSymmetryPointPatchField.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::basicSymmetryPointPatchField
26 
27 Description
28  A Symmetry boundary condition for pointField
29 
30 SourceFiles
31  basicsymmetryPointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef basicSymmetryPointPatchField_H
36 #define basicSymmetryPointPatchField_H
37 
38 #include "pointPatchField.H"
39 #include "symmetryPointPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class basicSymmetryPointPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public pointPatchField<Type>
54 {
55 
56 public:
57 
58  // Constructors
59 
60  //- Construct from patch and internal field
62  (
63  const pointPatch&,
65  );
66 
67  //- Construct from patch, internal field and dictionary
69  (
70  const pointPatch&,
72  const dictionary&
73  );
74 
75  //- Construct by mapping given patchField<Type> onto a new patch
77  (
79  const pointPatch&,
82  );
83 
84  //- Construct as copy setting internal field reference
86  (
89  );
90 
91  //- Construct and return a clone setting internal field reference
93  (
95  ) const
96  {
98  (
100  (
101  *this,
102  iF
103  )
104  );
105  }
106 
107 
108  // Member Functions
109 
110  // Evaluation functions
111 
112  //- Update the patch field
113  virtual void evaluate
114  (
115  const Pstream::commsTypes commsType =
117  );
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #ifdef NoRepository
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A Symmetry boundary condition for pointField.
commsTypes
Types of communications.
Definition: UPstream.H:64
Foam::pointPatchFieldMapper.
basicSymmetryPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Abstract base class for point-mesh patch fields.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Update the patch field.
autoPtr< pointPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Namespace for OpenFOAM.