From 2429c841e573beae49c505df7e4483907b6b87c1 Mon Sep 17 00:00:00 2001
From: andy <a.heather@opencfd.co.uk>
Date: Tue, 7 Sep 2010 16:11:32 +0100
Subject: [PATCH] ENH: More useful descriptions in header files
---
.../injectionModel/injectionModel/injectionModel.H | 9 +++++++++
.../surfaceFilmModel/surfaceFilmModel/surfaceFilmModel.H | 1 +
2 files changed, 10 insertions(+)
diff --git a/src/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H b/src/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H
index a05d028ffde..539184c7458 100644
--- a/src/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H
+++ b/src/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H
@@ -25,6 +25,15 @@ Class
Foam::injectionModel
Description
+ Injection model class for use with surface film modelling
+
+ Sets the newly injected fluid properties by manipulating two arrays:
+
+ - massToInject
+ - diameterToInject
+
+ This mass is later subtracted from the film
+
SourceFiles
injectionModelI.H
diff --git a/src/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel/surfaceFilmModel.H b/src/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel/surfaceFilmModel.H
index 9e9030fe2bb..c8c01ed6a72 100644
--- a/src/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel/surfaceFilmModel.H
+++ b/src/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel/surfaceFilmModel.H
@@ -25,6 +25,7 @@ Class
Foam::surfaceFilmModel
Description
+ Top level class that provides surface film modelling functionality
SourceFiles
surfaceFilmModelI.H
--
GitLab