StationaryPhaseModel: Header documentation

This commit is contained in:
Will Bainbridge
2018-03-26 10:29:14 +01:00
parent 828254ab34
commit d9be8b47f7
2 changed files with 14 additions and 9 deletions

View File

@ -26,17 +26,15 @@ Class
Description Description
Class which represents a moving fluid phase. Holds the velocity, fluxes and 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 Possible future extensions include separating the turbulent fuctionality
into another layer. It should also be possible to replace this layer with a into another layer.
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 ...).
Note that this class does not return the turbulence model, it just provides See also
indirect access to the turbulent data. This is so a layer without StationaryPhaseModel
turbulence modelling (such as a stationary model) could be substituted.
SourceFiles SourceFiles
MovingPhaseModel.C MovingPhaseModel.C

View File

@ -25,7 +25,14 @@ Class
Foam::StationaryPhaseModel Foam::StationaryPhaseModel
Description 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 SourceFiles
StationaryPhaseModel.C StationaryPhaseModel.C