emptyPointPatchField.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) 2011-2016 OpenFOAM Foundation
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::emptyPointPatchField
28 
29 Description
30  An empty boundary condition for pointField
31 
32 SourceFiles
33  emptyPointPatchField.txx
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef Foam_emptyPointPatchField_H
38 #define Foam_emptyPointPatchField_H
39 
40 #include "pointPatchField.H"
41 #include "emptyPointPatch.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class emptyPointPatchField Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public pointPatchField<Type>
56 {
59 
60 public:
61 
62  //- Runtime type information
63  TypeName(emptyPointPatch::typeName_()); // fieldTypes::emptyTypeName_()
64 
65 
66  // Constructors
67 
68  //- Construct from patch and internal field
70  (
71  const pointPatch&,
73  );
74 
75  //- Construct from patch, internal field and dictionary
77  (
78  const pointPatch&,
80  const dictionary&
81  );
82 
83  //- Construct by mapping onto a new patch
85  (
86  const this_bctype&,
87  const pointPatch&,
90  );
91 
92  //- Construct as copy setting internal field reference
94  (
95  const this_bctype&,
97  );
98 
99  //- No copy without an internal field
100  [[deprecated("2026-03: soon = delete")]]
101  emptyPointPatchField(const this_bctype& pfld)
102  #ifdef Foam_pointPatchField_copyConstruct
103  : this_bctype(pfld, pfld.internalField()) {}
104  #else
105  = delete;
106  #endif
107 
108  //- Clone with an internal field reference
110  (
112  ) const
113  {
114  return pointPatchField<Type>::Clone(*this, iF);
115  }
116 
117 
118  // Member Functions
120  //- The constraint type this pointPatchField implements
121  virtual const word& constraintType() const { return type(); }
122 
123 
124  // Member Operators
125 
126  //- Inherit assignment
128 };
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #ifdef NoRepository
138  #include "emptyPointPatchField.txx"
139 #endif
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************************************************************* //
TypeName(emptyPointPatch::typeName_())
Runtime type information.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:130
emptyPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Foam::pointPatchFieldMapper.
An empty boundary condition for pointField.
virtual autoPtr< pointPatchField< Type > > clone() const
No clone without an internal field reference.
friend Ostream & operator(Ostream &, const pointPatchField< Type > &)
Abstract base class for point-mesh patch fields.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:805
A class for handling words, derived from Foam::string.
Definition: word.H:63
static autoPtr< pointPatchField< Type > > Clone(const DerivedPatchField &pf, Args &&... args)
Clone a patch field, optionally with internal field reference etc.
virtual const word & constraintType() const
The constraint type this pointPatchField implements.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:64
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
const DimensionedField< Type, pointMesh > & internalField() const noexcept
Return const-reference to the dimensioned internal field.
Namespace for OpenFOAM.