Skip to content

Commit

Permalink
[docs] Add missing detailed description
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Aug 3, 2023
1 parent 166d4cc commit 6657b32
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions include/cantera/equil/vcs_VolPhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,9 @@ class vcs_VolPhase
*/
void setState_T(const double temperature_Kelvin);

// Downloads the ln ActCoeff Jacobian into the VCS version of the
// ln ActCoeff Jacobian.
/*
//! Downloads the ln ActCoeff Jacobian into the VCS version of the
//! ln ActCoeff Jacobian.
/**
* This is essentially a scatter operation.
*
* @param LnAcJac_VCS Jacobian parameter
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/equil/vcs_solve.h
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ class VCS_SOLVE

//! Recalculate all of the activity coefficients in all of the phases
//! based on input mole numbers
/*
/**
* @param moleSpeciesVCS kmol of species to be used in the update.
*
* NOTE: This routine needs to be regulated.
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/HMWSoln.h
Original file line number Diff line number Diff line change
Expand Up @@ -1966,7 +1966,7 @@ class HMWSoln : public MolalityVPSSTP
virtual void applyphScale(doublereal* acMolality) const;

private:
/*
/**
* This function will be called to update the internally stored
* natural logarithm of the molality activity coefficients
*/
Expand Down Expand Up @@ -1996,7 +1996,7 @@ class HMWSoln : public MolalityVPSSTP

//! This function will be called to update the internally stored
//! natural logarithm of the molality activity coefficients
/*
/**
* Normally they are all one. However, sometimes they are not,
* due to stability schemes
*
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/IdealSolnGasVPSS.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class IdealSolnGasVPSS : public VPStandardStateTP
}

//! Set the standard concentration model
/*
/**
* Must be one of 'unity', 'species-molar-volume', or 'solvent-molar-volume'.
*/
void setStandardConcentrationModel(const std::string& model);
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/MixtureFugacityTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ class MixtureFugacityTP : public ThermoPhase

//! Calculate the deviation terms for the total entropy of the mixture from
//! the ideal gas mixture
/*
/**
* Here we use the current state conditions
*
* @returns the change in entropy in units of J kmol-1 K-1.
Expand All @@ -361,7 +361,7 @@ class MixtureFugacityTP : public ThermoPhase

//! Calculate the deviation terms for the total enthalpy of the mixture from
//! the ideal gas mixture
/*
/**
* Here we use the current state conditions
*
* @returns the change in entropy in units of J kmol-1.
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/tpx/utils.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace tpx
Substance* GetSub(int isub);

//! Create a new Substance object corresponding to the specified name.
/*
/**
* Currently valid substances are:
*
* - water
Expand Down
4 changes: 2 additions & 2 deletions src/kinetics/solveSP.cpp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*
/**
* @file: solveSP.cpp Implicit surface site concentration solver
*/

Expand Down Expand Up @@ -523,7 +523,7 @@ static doublereal calc_damping(doublereal x[], doublereal dxneg[], size_t dim, i

} /* calc_damping */

/*
/**
* This function calculates the norm of an update, dx[], based on the
* weighted values of x.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/thermo/WaterPropsIAPWS.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ static const doublereal M_water = 18.015268;

static const double R_water = 461.51805; // J/kg/K (Eq. 6.3)

//! Gas constant that is quoted in the paper
// Gas constant that is quoted in the paper
/*
* Note, this is the Rgas value quoted in the paper. For consistency
* we have to use that value and not the updated value
Expand Down
2 changes: 1 addition & 1 deletion src/thermo/WaterPropsIAPWSphi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ using std::exp;
using std::pow;
using std::fabs;

/*
/**
* The added constants were calculated so that u = s = 0
* for liquid at the triple point. These where determined
* by the program testPress. I'm not quite satisfied with
Expand Down
4 changes: 2 additions & 2 deletions src/tpx/Sub.cpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! @file Sub.cpp
/*
/**
* @file Sub.cpp
* The Substance class
* D. Goodwin, Caltech Nov. 1996
*/
Expand Down

0 comments on commit 6657b32

Please sign in to comment.