energyJumpFvPatchScalarField.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) 2012-2018 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::energyJumpFvPatchScalarField
26 
27 Description
28  This boundary condition provides an energy jump condition across a pair
29  of coupled patches. It is not applied directly, but is employed on-the-fly
30  when converting temperature boundary conditions into energy.
31 
32 See also
33  Foam::fixedJumpFvPatchField
34 
35 SourceFiles
36  energyJumpFvPatchScalarField.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef energyJumpFvPatchScalarField_H
41 #define energyJumpFvPatchScalarField_H
42 
43 #include "fixedJumpFvPatchField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class energyJumpFvPatchScalarField Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public fixedJumpFvPatchField<scalar>
57 {
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("energyJump");
63 
64  // Constructors
65 
66  //- Construct from patch and internal field
68  (
69  const fvPatch&,
71  );
72 
73  //- Construct from patch, internal field and dictionary
75  (
76  const fvPatch&,
78  const dictionary&
79  );
80 
81  //- Construct by mapping given energyJumpFvPatchScalarField onto a
82  // new patch
84  (
86  const fvPatch&,
88  const fvPatchFieldMapper&
89  );
90 
91  //- Construct as copy
93  (
95  );
96 
97  //- Construct and return a clone
98  virtual tmp<fvPatchField<scalar>> clone() const
99  {
101  (
103  );
104  }
105 
106  //- Construct as copy setting internal field reference
108  (
111  );
112 
113  //- Construct and return a clone setting internal field reference
115  (
117  ) const
118  {
120  (
121  new energyJumpFvPatchScalarField(*this, iF)
122  );
123  }
124 
125 
126  // Member functions
127 
128  // Evaluation functions
129 
130  //- Update the coefficients
131  virtual void updateCoeffs();
132 
133 
134  //- Write
135  virtual void write(Ostream&) const;
136 };
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //
virtual void write(Ostream &) const
Write.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
This boundary condition provides an energy jump condition across a pair of coupled patches...
virtual tmp< fvPatchField< scalar > > clone() const
Construct and return a clone.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
energyJumpFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
This boundary condition provides a jump condition, using the cyclic condition as a base...
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
TypeName("energyJump")
Runtime type information.
Namespace for OpenFOAM.
virtual void updateCoeffs()
Update the coefficients.