energyJumpAMIFvPatchScalarField.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 | Copyright (C) 2012 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 Group
28  grpThermoBoundaryConditions grpCoupledBoundaryConditions
29 
30 Description
31  This boundary condition provides an energy jump condition across a pair
32  of coupled patches with an arbitrary mesh interface (AMI). It is not
33  applied directly, but is employed on-the-fly when converting temperature
34  boundary conditions into energy.
35 
36 SeeAlso
37  Foam::fixedJumpAMIFvPatchField
38 
39 SourceFiles
40  energyJumpAMIFvPatchScalarField.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef energyJumpAMIFvPatchScalarField_H
45 #define energyJumpAMIFvPatchScalarField_H
46 
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class energyJumpAMIFvPatchScalarField Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public fixedJumpAMIFvPatchField<scalar>
61 {
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("energyJumpAMI");
67 
68  // Constructors
69 
70  //- Construct from patch and internal field
72  (
73  const fvPatch&,
75  );
76 
77  //- Construct from patch, internal field and dictionary
79  (
80  const fvPatch&,
82  const dictionary&
83  );
84 
85  //- Construct by mapping given energyJumpAMIFvPatchScalarField onto a
86  // new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual tmp<fvPatchField<scalar> > clone() const
103  {
104  return tmp<fvPatchField<scalar> >
105  (
107  );
108  }
109 
110  //- Construct as copy setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
123  return tmp<fvPatchField<scalar> >
124  (
125  new energyJumpAMIFvPatchScalarField(*this, iF)
126  );
127  }
128 
129 
130  // Member functions
131 
132  // Evaluation functions
133 
134  //- Update the coefficients
135  virtual void updateCoeffs();
136 
137 
138  //- Write
139  virtual void write(Ostream&) const;
140 };
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
This boundary condition provides an energy jump condition across a pair of coupled patches with an ar...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
energyJumpAMIFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual tmp< fvPatchField< scalar > > clone() const
Construct and return a clone.
virtual void write(Ostream &) const
Write.
virtual void updateCoeffs()
Update the coefficients.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("energyJumpAMI")
Runtime type information.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
A class for managing temporary objects.
Definition: PtrList.H:118