Files
openfoam/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H

171 lines
4.9 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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::fixedInternalValueFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition provides a mechanism to set boundary (cell) values
directly into a matrix, i.e. to set a constraint condition. Default
behaviour is to act as a zero gradient condition.
Usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type fixedInternalValue;
value uniform 0; // place holder
}
\endverbatim
Note
This is used as a base for conditions such as the turbulence \c epsilon
wall function, which applies a near-wall constraint for high Reynolds
number flows.
SeeAlso
Foam::epsilonWallFunctionFvPatchScalarField
SourceFiles
fixedInternalValueFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef fixedInternalValueFvPatchField_H
#define fixedInternalValueFvPatchField_H
#include "zeroGradientFvPatchField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class fixedInternalValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fixedInternalValueFvPatchField
:
public zeroGradientFvPatchField<Type>
{
public:
//- Runtime type information
TypeName("fixedInternalValue");
// Constructors
//- Construct from patch and internal field
fixedInternalValueFvPatchField
(
const fvPatch&,
const DimensionedField<Type, volMesh>&
);
//- Construct from patch, internal field and dictionary
fixedInternalValueFvPatchField
(
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const dictionary&
);
//- Construct by mapping the given fixedInternalValueFvPatchField<Type>
// onto a new patch
fixedInternalValueFvPatchField
(
const fixedInternalValueFvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const fvPatchFieldMapper&
);
//- Construct as copy
fixedInternalValueFvPatchField
(
const fixedInternalValueFvPatchField<Type>&
);
//- Construct and return a clone
virtual tmp<fvPatchField<Type>> clone() const
{
return tmp<fvPatchField<Type>>
(
new fixedInternalValueFvPatchField<Type>(*this)
);
}
//- Construct as copy setting internal field reference
fixedInternalValueFvPatchField
(
const fixedInternalValueFvPatchField<Type>&,
const DimensionedField<Type, volMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvPatchField<Type>> clone
(
const DimensionedField<Type, volMesh>& iF
) const
{
return tmp<fvPatchField<Type>>
(
new fixedInternalValueFvPatchField<Type>(*this, iF)
);
}
// Member functions
// Evaluation functions
//-Manipulate a matrix
virtual void manipulateMatrix(fvMatrix<Type>& matrix);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fixedInternalValueFvPatchField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //