File size: 5,975 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::codedFixedValueFvPatchField
Description
Fixed value boundary condition evaluated from the code provided
which is compiled, linked and executed automatically at run-time.
The optional \c name entry specifies the name of the code generated from the
template, if not provided the it constructed as
\<field name\>_\<patch name\> for single region cases or
\<region name\>_\<field name\>_\<patch name\> for multi-region cases.
Usage
Example:
\verbatim
<patchName>
{
type codedFixedValue;
value uniform 0;
name rampedFixedValue; // Optional name of generated code
code
#{
operator==(min(10, 0.1*this->time().value()));
#};
// codeInclude
//#{
// #include ".H"
//#};
// codeOptions
//#{
// -I$(LIB_SRC)/finiteVolume/lnInclude
//#};
}
\endverbatim
See also
Foam::codedBase
Foam::dynamicCode
SourceFiles
codedFixedValueFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef codedFixedValueFvPatchField_H
#define codedFixedValueFvPatchField_H
#include "fixedValueFvPatchFields.H"
#include "codedBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class codedFixedValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class codedFixedValueFvPatchField
:
public fixedValueFvPatchField<Type>,
public codedBase
{
// Private Data
//- Keywords associated with source code
static const wordList codeKeys;
//- Name of the dictionary variables in the source code
static const wordList codeDictVars;
// Name of the code options template file
static const word codeOptions;
// Names of the source files to compile
static const wordList compileFiles;
// Names of the source files to copy (header files)
static const wordList copyFiles;
mutable autoPtr<fvPatchField<Type>> redirectPatchFieldPtr_;
public:
//- Runtime type information
TypeName("codedFixedValue");
// Constructors
//- Construct from patch, internal field and dictionary
codedFixedValueFvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const dictionary&
);
//- Construct by mapping given codedFixedValueFvPatchField
// onto a new patch
codedFixedValueFvPatchField
(
const codedFixedValueFvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const fieldMapper&
);
//- Disallow copy without setting internal field reference
codedFixedValueFvPatchField
(
const codedFixedValueFvPatchField<Type>&
) = delete;
//- Copy constructor setting internal field reference
codedFixedValueFvPatchField
(
const codedFixedValueFvPatchField<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 codedFixedValueFvPatchField<Type>(*this, iF)
);
}
// Member Functions
using fvPatchField<Type>::patch;
using fvPatchField<Type>::internalField;
//- Get reference to the underlying patch
const fvPatchField<Type>& redirectPatchField() const;
//- Update the coefficients associated with the patch field
virtual void updateCoeffs();
//- Evaluate the patch field, sets Updated to false
virtual void evaluate
(
const Pstream::commsTypes commsType=Pstream::commsTypes::blocking
);
//- Write
virtual void write(Ostream&) const;
// Member Operators
//- Inherit assignment
using fixedValueFvPatchField<Type>::operator=;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "codedFixedValueFvPatchField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|