All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
energyJumpAMIFvPatchScalarField.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-2019 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::energyJumpAMIFvPatchScalarField
26 
27 Description
28  This boundary condition provides an energy jump condition across a pair
29  of coupled patches with an arbitrary mesh interface (AMI). It is not
30  applied directly, but is employed on-the-fly when converting temperature
31  boundary conditions into energy.
32 
33 See also
34  Foam::fixedJumpAMIFvPatchField
35 
36 SourceFiles
37  energyJumpAMIFvPatchScalarField.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef energyJumpAMIFvPatchScalarField_H
42 #define energyJumpAMIFvPatchScalarField_H
43 
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class energyJumpAMIFvPatchScalarField Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public fixedJumpAMIFvPatchField<scalar>
58 {
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("energyJumpAMI");
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 energyJumpAMIFvPatchScalarField onto a
83  // new patch
85  (
87  const fvPatch&,
89  const fvPatchFieldMapper&
90  );
91 
92  //- Copy constructor
94  (
96  );
97 
98  //- Construct and return a clone
99  virtual tmp<fvPatchField<scalar>> clone() const
100  {
102  (
104  );
105  }
106 
107  //- Copy constructor setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
122  new energyJumpAMIFvPatchScalarField(*this, iF)
123  );
124  }
125 
126 
127  // Member Functions
128 
129  // Evaluation functions
130 
131  //- Update the coefficients
132  virtual void updateCoeffs();
133 
134 
135  //- Write
136  virtual void write(Ostream&) const;
137 };
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
virtual void updateCoeffs()
Update the coefficients.
TypeName("energyJumpAMI")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
This boundary condition provides an energy jump condition across a pair of coupled patches with an ar...
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
energyJumpAMIFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual tmp< fvPatchField< scalar > > clone() const
Construct and return a clone.
virtual void write(Ostream &) const
Write.
Namespace for OpenFOAM.