ENH: settings.(c)sh: added checking on SGIMPI MPI_ROOT
[OpenFOAM-2.0.x.git] / etc / codeTemplates / dynamicCode / fixedValueFvPatchFieldTemplate.H
blob4bb70e27ac5d8e84c837ee51da704ff5b8a5fce8
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Description
25     Template for use with dynamic code generation of a
26     fixedValue fvPatchField.
28     - without state
30 SourceFiles
31     fixedValueFvPatchFieldTemplate.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef fixedValueFvPatchTemplate${FieldType}_H
36 #define fixedValueFvPatchTemplate${FieldType}_H
38 #include "fixedValueFvPatchFields.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                          A templated FixedValueFvPatch
47 \*---------------------------------------------------------------------------*/
49 class ${typeName}FixedValueFvPatch${FieldType}
51     public fixedValueFvPatchField<${TemplateType}>
53 public:
55     //- Information about the SHA1 of the code itself
56     static const char* const SHA1sum;
58     //- Runtime type information
59     TypeName("${typeName}");
62     // Constructors
64         //- Construct from patch and internal field
65         ${typeName}FixedValueFvPatch${FieldType}
66         (
67             const fvPatch&,
68             const DimensionedField<${TemplateType}, volMesh>&
69         );
71         //- Construct from patch, internal field and dictionary
72         ${typeName}FixedValueFvPatch${FieldType}
73         (
74             const fvPatch&,
75             const DimensionedField<${TemplateType}, volMesh>&,
76             const dictionary&
77         );
79         //- Construct by mapping a copy onto a new patch
80         ${typeName}FixedValueFvPatch${FieldType}
81         (
82             const ${typeName}FixedValueFvPatch${FieldType}&,
83             const fvPatch&,
84             const DimensionedField<${TemplateType}, volMesh>&,
85             const fvPatchFieldMapper&
86         );
88         //- Construct as copy
89         ${typeName}FixedValueFvPatch${FieldType}
90         (
91             const ${typeName}FixedValueFvPatch${FieldType}&
92         );
94         //- Construct and return a clone
95         virtual tmp< fvPatch${FieldType} > clone() const
96         {
97             return tmp< fvPatch${FieldType} >
98             (
99                 new ${typeName}FixedValueFvPatch${FieldType}(*this)
100             );
101         }
103         //- Construct as copy setting internal field reference
104         ${typeName}FixedValueFvPatch${FieldType}
105         (
106             const ${typeName}FixedValueFvPatch${FieldType}&,
107             const DimensionedField<${TemplateType}, volMesh>&
108         );
110         //- Construct and return a clone setting internal field reference
111         virtual tmp< fvPatch${FieldType} > clone
112         (
113             const DimensionedField<${TemplateType}, volMesh>& iF
114         ) const
115         {
116             return tmp< fvPatch${FieldType} >
117             (
118                 new ${typeName}FixedValueFvPatch${FieldType}(*this, iF)
119             );
120         }
123     //- Destructor
124     virtual ~${typeName}FixedValueFvPatch${FieldType}();
127     // Member functions
129         //- Update the coefficients associated with the patch field
130         virtual void updateCoeffs();
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 } // End namespace Foam
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 #endif
142 // ************************************************************************* //