alphaFixedPressureFvPatchScalarField.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-2023 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::alphaFixedPressureFvPatchScalarField
26 
27 Description
28  A fixed-pressure alphaContactAngle boundary
29 
30 SourceFiles
31  alphaFixedPressureFvPatchScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef alphaFixedPressureFvPatchScalarField_H
36 #define alphaFixedPressureFvPatchScalarField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class alphaFixedPressureFvPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public fixedValueFvPatchScalarField
52 {
53  // Private Data
54 
55  //- Fixed pressure
56  scalarField p_;
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("alphaFixedPressure");
63 
64 
65  // Constructors
66 
67  //- Construct from patch, internal field and dictionary
69  (
70  const fvPatch&,
72  const dictionary&
73  );
74 
75  //- Construct by mapping given alphaFixedPressureFvPatchScalarField
76  // onto a new patch
78  (
80  const fvPatch&,
82  const fieldMapper&
83  );
84 
85  //- Disallow copy without setting internal field reference
87  (
89  ) = delete;
90 
91  //- Copy constructor setting internal field reference
93  (
96  );
97 
98  //- Construct and return a clone setting internal field reference
100  (
102  ) const
103  {
105  (
107  );
108  }
109 
110 
111  // Member Functions
112 
113  // Access
114 
115  //- Return the alphaFixed pressure
116  const scalarField& p() const
117  {
118  return p_;
119  }
120 
121  //- Return reference to the alphaFixed pressure to allow adjustment
122  scalarField& p()
123  {
124  return p_;
125  }
126 
127 
128  // Mapping functions
129 
130  //- Map the given fvPatchField onto this fvPatchField
131  virtual void map(const fvPatchScalarField&, const fieldMapper&);
132 
133  //- Reset the fvPatchField to the given fvPatchField
134  // Used for mesh to mesh mapping
135  virtual void reset(const fvPatchScalarField&);
136 
137 
138  // Evaluation functions
139 
140  //- Update the coefficients associated with the patch field
141  virtual void updateCoeffs();
142 
143 
144  //- Write
145  virtual void write(Ostream&) const;
146 };
147 
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 } // End namespace Foam
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A fixed-pressure alphaContactAngle boundary.
virtual void reset(const fvPatchScalarField &)
Reset the fvPatchField to the given fvPatchField.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
const scalarField & p() const
Return the alphaFixed pressure.
alphaFixedPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void map(const fvPatchScalarField &, const fieldMapper &)
Map the given fvPatchField onto this fvPatchField.
TypeName("alphaFixedPressure")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.