From 0a57fe20f56f868d2614449ecf14fe29c3d16453 Mon Sep 17 00:00:00 2001
From: andy <a.heather@opencfd.co.uk>
Date: Fri, 16 May 2008 11:28:15 +0100
Subject: [PATCH] updated header comments for doxygen
---
.../KinematicParcel/KinematicParcel.H | 48 +++++++++++++------
.../Templates/ReactingParcel/ReactingParcel.H | 31 ++++++++----
.../Templates/ThermoParcel/ThermoParcel.H | 13 +++--
3 files changed, 66 insertions(+), 26 deletions(-)
diff --git a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
index f18423e2576..3c21589622b 100644
--- a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
+++ b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
@@ -277,38 +277,58 @@ public:
//- Return type id
inline const label typeId() const;
- //- Return diameter
+ //- Return const access to diameter
inline const scalar d() const;
- inline scalar& d();
- //- Return velocity
+ //- Return const access to velocity
inline const vector& U() const;
- inline vector& U();
- //- Return relative velocity
+ //- Return const access to relative velocity
inline const vector& Ur() const;
- inline vector& Ur();
- //- Return number of particles
+ //- Return const access to number of particles
inline const scalar nParticle() const;
- inline scalar& nParticle();
- //- Return density
+ //- Return const access to density
inline const scalar rho() const;
- inline scalar& rho();
- //- Return time spent in turbulent eddy
+ //- Return const access to time spent in turbulent eddy
inline const scalar tTurb() const;
- inline scalar& tTurb();
- //- Return turbulent velocity fluctuation
+ //- Return const access to turbulent velocity fluctuation
inline const vector& UTurb() const;
- inline vector& UTurb();
//- The nearest distance to a wall that
// the particle can be in the n direction
inline scalar wallImpactDistance(const vector& n) const;
+
+ // Edit
+
+ //- Return access to diameter
+ inline scalar& d();
+
+ //- Return access to velocity
+ inline vector& U();
+
+ //- Return access to relative velocity
+ inline vector& Ur();
+
+ //- Return access to number of particles
+ inline scalar& nParticle();
+
+ //- Return access to density
+ inline scalar& rho();
+
+ //- Return access to time spent in turbulent eddy
+ inline scalar& tTurb();
+
+ //- Return access to turbulent velocity fluctuation
+ inline vector& UTurb();
+
+
+ // Helper functions
+
//- Return the index of the face to be used in the interpolation
// routine
inline label faceInterpolation() const;
diff --git a/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H b/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H
index 3b17542cd8e..11b625bd7be 100644
--- a/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H
+++ b/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H
@@ -259,24 +259,37 @@ public:
// Access
- //- Return mass fractions of gases
+ //- Return const access to mass fractions of gases
inline const scalarField& YGas() const;
- inline scalarField& YGas();
- //- Return mass fractions of liquids
+ //- Return const access to mass fractions of liquids
inline const scalarField& YLiquid() const;
- inline scalarField& YLiquid();
- //- Return mass fractions of solids
+ //- Return const access to mass fractions of solids
inline const scalarField& YSolid() const;
- inline scalarField& YSolid();
- //- Return mass fractions of mixture
+ //- Return const access to mass fractions of mixture
inline const scalarField& YMixture() const;
- inline scalarField& YMixture();
- //- Return initial mass
+ //- Return const access to initial mass
inline const scalar mass0() const;
+
+
+ // Edit
+
+ //- Return access to mass fractions of gases
+ inline scalarField& YGas();
+
+ //- Return access to mass fractions of liquids
+ inline scalarField& YLiquid();
+
+ //- Return access to mass fractions of solids
+ inline scalarField& YSolid();
+
+ //- Return access to mass fractions of mixture
+ inline scalarField& YMixture();
+
+ //- Return access to initial mass
inline scalar& mass0();
diff --git a/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H b/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H
index c9dd564cdfc..e73e25814ba 100644
--- a/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H
+++ b/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H
@@ -249,12 +249,19 @@ public:
// Access
- //- Return temperature
+ //- Return const access to temperature
inline const scalar T() const;
- inline scalar& T();
- //- Return specific heat capacity
+ //- Return const access to specific heat capacity
inline const scalar cp() const;
+
+
+ // Edit
+
+ //- Return access to temperature
+ inline scalar& T();
+
+ //- Return access to specific heat capacity
inline scalar& cp();
--
GitLab