/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021 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 .
Class
Foam::expInletFvPatchVectorField
Description
This boundary condition provides a expInlet condition,
calculated as:
\f[
Q = Q_{0} + Q_{p} + s*Q_{t}
\f]
where
\vartable
s | single scalar value [units]
Q_{0} | single vector value [units]
Q_{p} | vector field across patch [units]
Q_{t} | vector function of time [units]
\endtable
Usage
\table
Property | Description | Req'd? | Default
scalarData | single scalar value | yes |
data | single vector value | yes |
fieldData | vector field across patch | yes |
timeVsData | vector function of time | yes |
wordData | word, eg name of data object | no | wordDefault
\endtable
Example of the boundary condition specification:
\verbatim
{
type expInlet;
scalarData -1;
data (1 0 0);
fieldData uniform (3 0 0);
timeVsData table (
(0 (0 0 0))
(1 (2 0 0))
);
wordName anotherName;
value uniform (4 0 0); // optional initial value
}
\endverbatim
SourceFiles
expInletFvPatchVectorField.C
\*---------------------------------------------------------------------------*/
#ifndef BC_H
#define BC_H
#include "fixedValueFvPatchFields.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class expInletFvPatchVectorField Declaration
\*---------------------------------------------------------------------------*/
class expInletFvPatchVectorField
:
public fixedValueFvPatchVectorField
{
// Private Data
//- Single valued scalar quantity, e.g. a coefficient
scalar scalarData_;
//- Single valued Type quantity, e.g. reference pressure pRefValue_
// Other options include vector, tensor
vector data_;
//- Field of Types, typically defined across patch faces
// e.g. total pressure p0_. Other options include vectorField
vectorField fieldData_;
//- Type specified as a function of time for time-varying BCs
autoPtr> timeVsData_;
//- Word entry, e.g. pName_ for name of the pressure field on database
word wordData_;
//- Label, e.g. patch index, current time index
label labelData_;
//- Boolean for true/false, e.g. specify if flow rate is volumetric_
bool boolData_;
// Private Member Functions
//- Return current time
scalar t() const;
public:
//- Runtime type information
TypeName("expInlet");
// Constructors
//- Construct from patch and internal field
expInletFvPatchVectorField
(
const fvPatch&,
const DimensionedField&
);
//- Construct from patch, internal field and dictionary
expInletFvPatchVectorField
(
const fvPatch&,
const DimensionedField&,
const dictionary&
);
//- Construct by mapping given fixedValueTypeFvPatchField
// onto a new patch
expInletFvPatchVectorField
(
const expInletFvPatchVectorField&,
const fvPatch&,
const DimensionedField&,
const fvPatchFieldMapper&
);
//- Copy constructor
expInletFvPatchVectorField
(
const expInletFvPatchVectorField&
);
//- Construct and return a clone
virtual tmp clone() const
{
return tmp
(
new expInletFvPatchVectorField(*this)
);
}
//- Copy constructor setting internal field reference
expInletFvPatchVectorField
(
const expInletFvPatchVectorField&,
const DimensionedField&
);
//- Construct and return a clone setting internal field reference
virtual tmp clone
(
const DimensionedField& iF
) const
{
return tmp
(
new expInletFvPatchVectorField
(
*this,
iF
)
);
}
// Member Functions
// Mapping functions
//- Map (and resize as needed) from self given a mapping object
// Used to update fields following mesh topology change
virtual void autoMap(const fvPatchFieldMapper&);
//- Reverse map the given fvPatchField onto this fvPatchField
// Used to reconstruct fields
virtual void rmap(const fvPatchVectorField&, const labelList&);
// Evaluation functions
//- Update the coefficients associated with the patch field
virtual void updateCoeffs();
//- Write
virtual void write(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //