Remove trailing whitespace systematically
[foam-extend-3.2.git] / applications / solvers / coupled / conjugateHeatTransfer / fvPatchFields / adiabatic / adiabaticFvPatchScalarField.H
blobb4c7bf87aa6d522e435382045748094af303331c
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     |
5     \\  /    A nd           | For copyright notice see file Copyright
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     adiabaticFvPatchScalarField
27 Description
28     adiabatic boundary (with radiation)
30     Example usage:
31         myWallPatch
32         {
33             type            adiabatic;
34             K               K;                 // Name of K field
35             value           300.0;             // Initial temperature / [K]
36         }
39 SourceFiles
40     adiabaticFvPatchScalarField.C
42 \*---------------------------------------------------------------------------*/
44 #ifndef adiabaticFvPatchScalarField_H
45 #define adiabaticFvPatchScalarField_H
47 #include "mixedFvPatchFields.H"
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 namespace Foam
54 /*---------------------------------------------------------------------------*\
55       Class adiabaticFvPatchScalarField Declaration
56 \*---------------------------------------------------------------------------*/
58 class adiabaticFvPatchScalarField
60     public mixedFvPatchScalarField
62     // Private data
64         //- Name of thermal conductivity field
65         word KName_;
68 public:
70     //- Runtime type information
71     TypeName("adiabatic");
74     // Constructors
76         //- Construct from patch and internal field
77         adiabaticFvPatchScalarField
78         (
79             const fvPatch&,
80             const DimensionedField<scalar, volMesh>&
81         );
83         //- Construct from patch, internal field and dictionary
84         adiabaticFvPatchScalarField
85         (
86             const fvPatch&,
87             const DimensionedField<scalar, volMesh>&,
88             const dictionary&
89         );
91         //- Construct by mapping given
92         // adiabaticFvPatchScalarField
93         // onto a new patch
94         adiabaticFvPatchScalarField
95         (
96             const adiabaticFvPatchScalarField&,
97             const fvPatch&,
98             const DimensionedField<scalar, volMesh>&,
99             const fvPatchFieldMapper&
100         );
102         //- Construct as copy
103         adiabaticFvPatchScalarField
104         (
105             const adiabaticFvPatchScalarField&
106         );
108         //- Construct and return a clone
109         virtual tmp<fvPatchScalarField> clone() const
110         {
111             return tmp<fvPatchScalarField>
112             (
113                 new adiabaticFvPatchScalarField(*this)
114             );
115         }
117         //- Construct as copy setting internal field reference
118         adiabaticFvPatchScalarField
119         (
120             const adiabaticFvPatchScalarField&,
121             const DimensionedField<scalar, volMesh>&
122         );
124         //- Construct and return a clone setting internal field reference
125         virtual tmp<fvPatchScalarField> clone
126         (
127             const DimensionedField<scalar, volMesh>& iF
128         ) const
129         {
130             return tmp<fvPatchScalarField>
131             (
132                 new adiabaticFvPatchScalarField(*this, iF)
133             );
134         }
137     // Member functions
139         // Evaluation functions
141             //- Update the coefficients associated with the patch field
142             virtual void updateCoeffs();
145         // Mapping functions
148         // I-O
150             //- Write
151             void write(Ostream&) const;
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 } // End namespace Foam
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 #endif
163 // ************************************************************************* //