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-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::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 and internal field
69  (
70  const fvPatch&,
72  );
73 
74  //- Construct from patch, internal field and dictionary
76  (
77  const fvPatch&,
79  const dictionary&
80  );
81 
82  //- Construct by mapping given alphaFixedPressureFvPatchScalarField
83  // onto a new patch
85  (
87  const fvPatch&,
89  const fvPatchFieldMapper&
90  );
91 
92  //- Disallow copy without setting internal field reference
94  (
96  ) = delete;
97 
98  //- Copy constructor setting internal field reference
100  (
103  );
104 
105  //- Construct and return a clone setting internal field reference
107  (
109  ) const
110  {
112  (
114  );
115  }
116 
117 
118  // Member Functions
119 
120  // Access
121 
122  //- Return the alphaFixed pressure
123  const scalarField& p() const
124  {
125  return p_;
126  }
127 
128  //- Return reference to the alphaFixed pressure to allow adjustment
129  scalarField& p()
130  {
131  return p_;
132  }
133 
134 
135  // Mapping functions
136 
137  //- Map (and resize as needed) from self given a mapping object
138  // Used to update fields following mesh topology change
139  virtual void autoMap(const fvPatchFieldMapper&);
140 
141  //- Reverse map the given fvPatchField onto this fvPatchField
142  // Used to reconstruct fields
143  virtual void rmap(const fvPatchScalarField&, const labelList&);
144 
145 
146  // Evaluation functions
147 
148  //- Update the coefficients associated with the patch field
149  virtual void updateCoeffs();
150 
151 
152  //- Write
153  virtual void write(Ostream&) const;
154 };
155 
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 } // End namespace Foam
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 #endif
164 
165 // ************************************************************************* //
alphaFixedPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
TypeName("alphaFixedPressure")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
const scalarField & p() const
Return the alphaFixed pressure.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
A fixed-pressure alphaContactAngle boundary.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.