alphaFixedPressureFvPatchScalarField.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-2013 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::alphaFixedPressureFvPatchScalarField
28 
29 Description
30  A fixed-pressure alphaContactAngle boundary
31 
32 SourceFiles
33  alphaFixedPressureFvPatchScalarField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef alphaFixedPressureFvPatchScalarField_H
38 #define alphaFixedPressureFvPatchScalarField_H
39 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class alphaFixedPressureFvPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public fixedValueFvPatchScalarField
54 {
55  // Private data
56 
57  //- Fixed pressure
58  scalarField p_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("alphaFixedPressure");
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const fvPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const fvPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping given alphaFixedPressureFvPatchScalarField
85  // onto a new patch
87  (
89  const fvPatch&,
91  const fvPatchFieldMapper&
92  );
93 
94  //- Construct as copy
96  (
98  );
99 
100  //- Construct and return a clone
101  virtual tmp<fvPatchScalarField> clone() const
102  {
104  (
106  );
107  }
108 
109  //- Construct as copy setting internal field reference
111  (
114  );
115 
116  //- Construct and return a clone setting internal field reference
118  (
120  ) const
121  {
123  (
125  );
126  }
127 
128 
129  // Member functions
130 
131  // Access
132 
133  //- Return the alphaFixed pressure
134  const scalarField& p() const
135  {
136  return p_;
137  }
138 
139  //- Return reference to the alphaFixed pressure to allow adjustment
140  scalarField& p()
141  {
142  return p_;
143  }
144 
145 
146  // Mapping functions
147 
148  //- Map (and resize as needed) from self given a mapping object
149  virtual void autoMap
150  (
151  const fvPatchFieldMapper&
152  );
153 
154  //- Reverse map the given fvPatchField onto this fvPatchField
155  virtual void rmap
156  (
157  const fvPatchScalarField&,
158  const labelList&
159  );
160 
161 
162  // Evaluation functions
163 
164  //- Update the coefficients associated with the patch field
165  virtual void updateCoeffs();
166 
167 
168  //- Write
169  virtual void write(Ostream&) const;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
Foam::fvPatchField< scalar >
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::alphaFixedPressureFvPatchScalarField::rmap
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: alphaFixedPressureFvPatchScalarField.C:125
Foam::alphaFixedPressureFvPatchScalarField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: alphaFixedPressureFvPatchScalarField.C:115
Foam::alphaFixedPressureFvPatchScalarField::TypeName
TypeName("alphaFixedPressure")
Runtime type information.
Foam::Field< scalar >
Foam::alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField
alphaFixedPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: alphaFixedPressureFvPatchScalarField.C:40
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::alphaFixedPressureFvPatchScalarField
A fixed-pressure alphaContactAngle boundary.
Definition: alphaFixedPressureFvPatchScalarField.H:50
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::alphaFixedPressureFvPatchScalarField::p
const scalarField & p() const
Return the alphaFixed pressure.
Definition: alphaFixedPressureFvPatchScalarField.H:133
Foam::List< label >
Foam::alphaFixedPressureFvPatchScalarField::p
scalarField & p()
Return reference to the alphaFixed pressure to allow adjustment.
Definition: alphaFixedPressureFvPatchScalarField.H:139
fixedValueFvPatchFields.H
Foam::alphaFixedPressureFvPatchScalarField::write
virtual void write(Ostream &) const
Write.
Definition: alphaFixedPressureFvPatchScalarField.C:159
Foam::alphaFixedPressureFvPatchScalarField::clone
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Definition: alphaFixedPressureFvPatchScalarField.H:100
Foam::alphaFixedPressureFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: alphaFixedPressureFvPatchScalarField.C:139
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54