zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Documentation updates

Browse Source
This commit is contained in:
andy
2013-02-26 15:55:44 +00:00
parent 95cb3a268f
commit fe20510296
8 changed files with 234 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/fvOptions/sources/derived/MRFSource/MRFSource.H
View File

@ -8,10 +8,10 @@
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 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
@ -19,8 +19,7 @@ License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::MRFSource
@ -28,14 +27,18 @@ Class
Description
Multiple Reference Frame (MRF) source
Example usage:
\heading Source usage
Example usage:
\verbatim
MRFSourceCoeffs
{
origin (0 0 0);
axis (0 0 1);
omega 104.72;
}
\endverbatim
SourceFiles
MRFSource.C

36
src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H
View File

@ -8,10 +8,10 @@
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 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
@ -19,8 +19,7 @@ License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::actuationDiskSource
@ -29,18 +28,26 @@ Description
Actuation disk source
Constant values for momentum source for actuation disk
T = 2*rho*A*sqr(Uo)*a*(1-a)
U1 = (1 -a)Uo
\f[
T = 2 \rho A U_{o}^2 a (1-a)
\f]
and
\f[
U_1 = (1 - a)U_{o}
\f]
where:
A: disk area
Uo: upstream velocity
a: 1 - Cp/Ct
U1: velocity at the disk
\vartable
A | disk area
U_o | upstream velocity
a | 1 - Cp/Ct
U_1 | velocity at the disk
\endvartable
Sources described by:
\heading Source usage
Example usage:
\verbatim
actuationDiskSourceCoeffs
{
fieldNames (U); // names of fields to apply source
@ -50,6 +57,7 @@ Description
diskArea 5.0; // disk area
upstreamPoint (0 0 0); // upstream point
}
\endverbatim
SourceFiles

74
src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
View File

@ -8,10 +8,10 @@
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 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
@ -19,38 +19,50 @@ License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::effectivenessHeatExchangerSource
Description
Heat exchanger source model.
The total heat exchange is given by:
Heat exchanger source model, in which the heat exchanger is defined as a
selection of cells.
Qt = e(phi, secondaryMassFlowRate)
* (secondaryInletT - primaryInletT)
* phi*Cp;
The total heat exchange source is given by:
\f[
Q_t = e(\phi, \dot{m}_2) (T_2 - T_1) \phi c_p
\f]
where:
e(phi, secondaryMassFlowRate) is a effectivenes table in function of
mass net flux coming imto the heat exchanger (phi) and
secondaryMassFlowRate
\vartable
Q_t | total heat source
e(\phi,\dot{m}_2) | effectivenes table
\phi | net mass flux entering heat exchanger [kg/s]
\dot{m}_2 | secondary mass flow rate [kg/s]
T_1 | primary inlet temperature [K]
T_2 | secondary inlet temperature [K]
c_p | specific heat capacity [J/kg/K]
\endvartable
Then the distribution inside the hear exchanger is given by:
Qcell = Vcell*|Ucell|*(Tcell - Tref)/sum(Vcell*|Ucell|*(Tcell - Tref));
The distribution inside the hear exchanger is given by:
\f[
Q_c = \frac{V_c |U_c| (T_c - T_{ref})}{\sum(V_c |U_c| (T_c - T_{ref}))}
\f]
where:
Qcell is the source for cell
Vcell is the volume of the cell
Ucell is the local cell velocity
Tcell is the local call temperature
Tref : min(T) or max(T) in the cell zone depending on the sign of Qt
\vartable
Q_c | source for cell
V_c | volume of the cell [m3]
U_c | local cell velocity [m/s]
T_c | local call temperature [K]
T_{ref} | min or max(T) in cell zone depending on the sign of Q_t [K]
\endvartable
Example :
\heading Source usage
Example usage:
\verbatim
effectivenessHeatExchangerSource1
{
type effectivenessHeatExchangerSource;
@ -69,11 +81,12 @@ Description
fileName "effTable";
}
}
\endverbatim
Note:
the table with name "fileName" should have the same units as
secondaryMassFlowRate and kg/s for phi
faceZone is the faces at the inlet of the cellzone, it needs to be
Note
- the table with name "fileName" should have the same units as the
secondary mass flow rate and kg/s for phi
- faceZone is the faces at the inlet of the cellzone, it needs to be
created with flip map flags. It is used to integrate the net mass flow
rate into the heat exchanger
@ -110,7 +123,7 @@ protected:
// Protected data
//- Secondary flow mass rate [Kg/s]
//- Secondary flow mass rate [kg/s]
scalar secondaryMassFlowRate_;
//- Inlet secondary temperature [K]
@ -119,8 +132,8 @@ protected:
//- Primary air temperature at the heat exchanger inlet [K]
scalar primaryInletT_;
//- 2D look up table efficiency = F(total primary mass flow rate [Kg/s]
//, secondary mass flow rate [Kg/s])
//- 2D look up table efficiency = function of primary and secondary
// mass flow rates [kg/s]
autoPtr<interpolation2DTable<scalar> > eTable_;
//- Name of velocity field; default = U
@ -144,8 +157,7 @@ protected:
//- Local list of patch ID per face
labelList facePatchId_;
//- List of +1/-1 representing face flip map
// (1 use as is, -1 negate)
//- List of +1/-1 representing face flip map (1 use as is, -1 negate)
labelList faceSign_;
//- Area of the face zone

16
src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H
View File

@ -8,10 +8,10 @@
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 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
@ -19,8 +19,7 @@ License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::explicitPorositySource
@ -28,8 +27,10 @@ Class
Description
Explicit porosity source
Sources described by, for example using the DarcyForchheimer model:
\heading Source usage
Example usage, here employing the Darcy-Forchheimer model:
\verbatim
explicitPorositySourceCoeffs
{
type DarcyForchheimer;
@ -45,6 +46,7 @@ Description
}
}
}
\endverbatim
Note:
The porous region must be selected as a cellZone.

6
src/fvOptions/sources/derived/pressureGradientExplicitSource/pressureGradientExplicitSource.H
View File

@ -29,8 +29,9 @@ Description
Note: Currently only handles kinematic pressure
Sources described by:
\heading Source usage
Example usage:
\verbatim
pressureGradientExplicitSourceCoeffs
{
fieldNames (U); // name of velocity field
@ -38,6 +39,7 @@ Description
gradPini gradPini [0 2 -2 0 0] 0; // initial pressure gradient
flowDir (1 0 0); // flow direction
}
\endverbatim
SourceFiles

44
src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H
View File

@ -8,10 +8,10 @@
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 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
@ -19,32 +19,41 @@ License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::radialActuationDiskSource
Description
Actuation disk zone definition.
Constant values for momentum source for actuation disk
Actuation disk source including radial thrust
T = 2*rho*A*sqr(Uo)*a*(1-a)
U1 = (1 -a)Uo
Constant values for momentum source for actuation disk
\f[
T = 2 \rho A U_{o}^2 a (1-a)
\f]
and
\f[
U_1 = (1 - a)U_{o}
\f]
where:
A: disk area
Uo: upstream velocity
a: 1 - Cp/Ct
U1: velocity at the disk
\vartable
A | disk area
U_o | upstream velocity
a | 1 - Cp/Ct
U_1 | velocity at the disk
\endvartable
The thrust is distributed by a radial function:
\f[
thrust(r) = T (C_0 + C_1 r^2 + C_2 r^4)
\f]
thrust(r) = T*(C0 + C1*r^2 + C2*r^4)
Sources described by:
\heading Source usage
Example usage:
\verbatim
actuationDiskSourceCoeffs
{
fieldName U; // name of field to apply source
@ -55,6 +64,7 @@ Description
coeffs (0.1 0.5 0.01); // radial distribution coefficients
upstreamPoint (0 0 0); // upstream point
}
\endverbatim
SourceFiles

20
src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H
View File

@ -30,8 +30,10 @@ Description
Source approximates the mean effects of rotor forces on a cylindrical
region within the domain
Sources described by:
\heading Source usage
Example usage:
\verbatim
rotorDiskSourceCoeffs
{
fieldNames (U); // names of fields on which to apply source
@ -65,17 +67,17 @@ Description
...
}
}
\endverbatim
Where:
Valid options for the \c geometryMode entry include:
- auto : determine rototor co-ord system from cells
- specified : specified co-ord system
geometryMode =
auto : determine rototor co-ord system from cells
specified : specified co-ord system
inletFlowType =
fixed : specified velocity
surfaceNormal : specified normal velocity (positive towards rotor)
local : use local flow conditions
Valid options for the \c inletFlowType entry include:
- fixed : specified velocity
- local : use local flow conditions
- surfaceNormal : specified normal velocity (positive towards rotor)
SourceFiles

16
src/fvOptions/sources/general/codedSource/CodedSource.H
View File

@ -25,18 +25,12 @@ Class
Foam::fv::codedSource
Description
Constructs on-the-fly a new fvOption.
Constructs on-the-fly source
E.g. in system/fvOptions
momentumSource
{
type vectorCodedSource;
active on; //on/off switch
timeStart 0.0; //start time
duration 1000000.0; //duration
selectionMode all; //cellSet // points //cellZone
\heading Source usage
Example usage:
\verbatim
vectorCodedSourceCoeffs
{
fieldNames (U);
@ -69,7 +63,7 @@ Description
// Dummy entry
rampCoeffs
{}
}
\endverbatim
SourceFiles