From d9be8b47f7c5fda9c1ddbdb9c65a2ff83c57c491 Mon Sep 17 00:00:00 2001 From: Will Bainbridge Date: Mon, 26 Mar 2018 10:29:14 +0100 Subject: [PATCH] StationaryPhaseModel: Header documentation --- .../phaseModel/MovingPhaseModel/MovingPhaseModel.H | 14 ++++++-------- .../StationaryPhaseModel/StationaryPhaseModel.H | 9 ++++++++- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/MovingPhaseModel/MovingPhaseModel.H b/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/MovingPhaseModel/MovingPhaseModel.H index e60e601ab4..3638e33f31 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/MovingPhaseModel/MovingPhaseModel.H +++ b/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/MovingPhaseModel/MovingPhaseModel.H @@ -26,17 +26,15 @@ Class Description Class which represents a moving fluid phase. Holds the velocity, fluxes and - turbulence model. Provides access to the turbulent quantities. + turbulence model and can generate the momentum equation. The interface is + quite restrictive as it also has to support an equivalent stationary model, + which does not store motion fields or a turbulence model. Possible future extensions include separating the turbulent fuctionality - into another layer. It should also be possible to replace this layer with a - stationary phase model, in order to model packed beds or simple porous - media. This would probably require extra functionality, such as returning - the inputs into the general pressure equation (A, HbyA, etc ...). + into another layer. - Note that this class does not return the turbulence model, it just provides - indirect access to the turbulent data. This is so a layer without - turbulence modelling (such as a stationary model) could be substituted. +See also + StationaryPhaseModel SourceFiles MovingPhaseModel.C diff --git a/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/StationaryPhaseModel/StationaryPhaseModel.H b/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/StationaryPhaseModel/StationaryPhaseModel.H index b2d0822e8e..28fb5621f2 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/StationaryPhaseModel/StationaryPhaseModel.H +++ b/applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/StationaryPhaseModel/StationaryPhaseModel.H @@ -25,7 +25,14 @@ Class Foam::StationaryPhaseModel Description - ... + Class which represents a stationary (and therefore probably solid) phase. + Generates, but does not store, zero velocity and flux field and turbulent + qauantities. Throws an error when non-const access is requested to the + motion fields or when the momentum equation is requested. Usage must + must protect against such calls. + +See also + MovingPhaseModel SourceFiles StationaryPhaseModel.C