File size: 6,709 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::mappedValueFvPatchField
Description
This boundary condition maps the values from a neighbouring patch to this
patch.
Usage
\table
Property | Description | Required | Default value
field | name of field to be mapped | no | this field name
setAverage | set the average value? | no | yes if average \\
is specified, \\
no otherwise
average | average value to apply | if setAverage is true |
\endtable
Example of the boundary condition specification:
\verbatim
<patchName>
{
type mappedValue;
field T;
average 300;
value uniform 300;
}
\endverbatim
This boundary condition will usually be applied to a patch which is of
mappedPatchBase type, and which holds all the necessary mapping
information. It can also create its own mapping data which overrides that
in the mapped patch, or so that it can be applied to a non-mapped patch.
This is triggered by the presence of controls relating to mappedPatchBase
(i.e., neighbourRegion, neighbourPatch, etc ...).
See also
Foam::mappedPatchBase
Foam::mappedPolyPatch
Foam::mappedFvPatch
SourceFiles
mappedValueFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef mappedValueFvPatchField_H
#define mappedValueFvPatchField_H
#include "fixedValueFvPatchFields.H"
#include "mappedPatchBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class mappedValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class mappedValueFvPatchField
:
public fixedValueFvPatchField<Type>
{
protected:
// Protected Data
//- The field to map
const word fieldName_;
//- If true adjust the sampled field to maintain an average value
const bool setAverage_;
//- Average value the sampled field is adjusted to
const Type average_;
//- The mapping engine
autoPtr<mappedPatchBase> mapperPtr_;
// Protected Member Functions
//- Return the mapping engine
const mappedPatchBase& mapper() const;
//- Return the neighbouring patch field
const fvPatchField<Type>& nbrPatchField() const;
//- Return the mapped values, given the neighbouring field
tmp<Field<Type>> mappedValues(const Field<Type>& nbrPatchField) const;
public:
//- Runtime type information
TypeName("mappedValue");
// Constructors
//- Construct from patch and internal field
mappedValueFvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&
);
//- Construct from patch, internal field and dictionary
mappedValueFvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const dictionary&
);
//- Construct by mapping given mappedValueFvPatchField
// onto a new patch
mappedValueFvPatchField
(
const mappedValueFvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const fieldMapper&
);
//- Disallow copy without setting internal field reference
mappedValueFvPatchField
(
const mappedValueFvPatchField<Type>&
) = delete;
//- Copy constructor setting internal field reference
mappedValueFvPatchField
(
const mappedValueFvPatchField<Type>&,
const DimensionedField<Type, fvMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvPatchField<Type>> clone
(
const DimensionedField<Type, fvMesh>& iF
) const
{
return tmp<fvPatchField<Type>>
(
new mappedValueFvPatchField<Type>(*this, iF)
);
}
// Member Functions
using fvPatchField<Type>::patch;
using fvPatchField<Type>::internalField;
// Mapping functions
//- Map the given fvPatchField onto this fvPatchField
virtual void map(const fvPatchField<Type>&, const fieldMapper&);
//- Reset the fvPatchField to the given fvPatchField
// Used for mesh to mesh mapping
virtual void reset(const fvPatchField<Type>&);
// Evaluation functions
//- Update the coefficients associated with the patch field
virtual void updateCoeffs();
//- Write
virtual void write(Ostream&) const;
// Member Operators
//- Inherit assignment
using fixedValueFvPatchField<Type>::operator=;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "mappedValueFvPatchField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|