File size: 5,644 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-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::waveAlphaFvPatchScalarField
Description
This boundary condition provides a waveAlpha condition. This sets the phase
fraction to that specified by a superposition of wave models. All the
wave modelling parameters are obtained from a centrally registered
waveSuperposition class.
Usage
\table
Property | Description | Required? | Default
phi | Name of the flux field | no | phi
liquid | Is the alpha field that of the liquid? | no | true
\endtable
Example of the boundary condition specification:
\verbatim
<patchName>
{
type waveAlpha;
libs ("libwaves.so");
liquid true;
}
\endverbatim
See also
Foam::waveSuperposition
SourceFiles
waveAlphaFvPatchScalarField.C
\*---------------------------------------------------------------------------*/
#ifndef waveAlphaFvPatchScalarField_H
#define waveAlphaFvPatchScalarField_H
#include "fixedValueInletOutletFvPatchFields.H"
#include "waveSuperposition.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class fvMeshSubset;
/*---------------------------------------------------------------------------*\
Class waveAlphaFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class waveAlphaFvPatchScalarField
:
public fixedValueInletOutletFvPatchScalarField
{
// Private Data
//- Is this alpha field that of the liquid under the wave?
const Switch liquid_;
//- Mesh subset corresponding to the patch adjacent cells
mutable autoPtr<fvMeshSubset> faceCellSubset_;
//- Time index for keeping the subset up to date
mutable label faceCellSubsetTimeIndex_;
public:
//- Runtime type information
TypeName("waveAlpha");
// Constructors
//- Construct from patch, internal field and dictionary
waveAlphaFvPatchScalarField
(
const fvPatch&,
const DimensionedField<scalar, fvMesh>&,
const dictionary&
);
//- Construct by mapping given fixedValueTypeFvPatchField onto a new
// patch
waveAlphaFvPatchScalarField
(
const waveAlphaFvPatchScalarField&,
const fvPatch&,
const DimensionedField<scalar, fvMesh>&,
const fieldMapper&
);
//- Disallow copy without setting internal field reference
waveAlphaFvPatchScalarField
(
const waveAlphaFvPatchScalarField&
) = delete;
//- Copy constructor setting internal field reference
waveAlphaFvPatchScalarField
(
const waveAlphaFvPatchScalarField&,
const DimensionedField<scalar, fvMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvPatchScalarField> clone
(
const DimensionedField<scalar, fvMesh>& iF
) const
{
return tmp<fvPatchScalarField>
(
new waveAlphaFvPatchScalarField(*this, iF)
);
}
// Member Functions
// Access
//- Access the liquid flag
bool liquid() const
{
return liquid_;
}
//- Access the face-cell subset
const fvMeshSubset& faceCellSubset() const;
// Evaluation functions
//- Return the current modelled phase fraction field on the patch
// faces at the given time
tmp<scalarField> alpha(const scalar t) const;
//- Return the current modelled phase fraction field in the
// neighbour cells at the given time
tmp<scalarField> alphan(const scalar t) const;
//- Update the coefficients associated with the patch field
virtual void updateCoeffs();
//- Write
virtual void write(Ostream&) const;
// Member Operators
//- Inherit assignment
using fixedValueInletOutletFvPatchScalarField::operator=;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|