From ab8f620ccbae65e57030376280c1cea8f4847fd7 Mon Sep 17 00:00:00 2001 From: Dave Goodwin Date: Sat, 28 Aug 2004 16:12:41 +0000 Subject: [PATCH] cleanup --- Cantera/src/ArrayViewer.h | 9 +- Cantera/src/DenseMatrix.cpp | 4 - Cantera/src/EdgeKinetics.h | 1 - Cantera/src/GRI_30_Kinetics.h | 2 +- Cantera/src/GasKineticsWriter.h | 2 +- Cantera/src/InterfaceKinetics.h | 3 - Cantera/src/PureFluidPhase.h | 2 +- Cantera/src/ReactionStoichMgr.h | 15 +-- Cantera/src/SimpleThermo.h | 2 +- Cantera/src/SpeciesThermoMgr.h | 12 +-- Cantera/src/StoichManager.h | 4 +- Cantera/src/StoichSubstance.h | 6 +- Cantera/src/ThermoPhase.h | 26 +++--- Cantera/src/converters/CKParser.cpp | 8 +- Cantera/src/converters/Group.h | 2 +- Cantera/src/converters/Reaction.h | 6 +- Cantera/src/converters/atomicWeightDB.cpp | 4 +- Cantera/src/converters/config.h | 6 -- Cantera/src/converters/filter.cpp | 2 +- Cantera/src/converters/thermoFunctions.cpp | 7 -- Cantera/src/newton_utils.cpp | 102 --------------------- Cantera/src/oneD/Jac1D.h | 88 ------------------ Cantera/src/oneD/Newton1D.h | 73 --------------- Cantera/src/oneD/Solid1D.cpp | 2 +- Cantera/src/oneD/newton_utils.cpp | 12 +-- Cantera/src/zeroD/Reactor.cpp | 10 +- Cantera/src/zeroD/Reservoir.h | 2 +- 27 files changed, 60 insertions(+), 352 deletions(-) delete mode 100755 Cantera/src/newton_utils.cpp delete mode 100644 Cantera/src/oneD/Jac1D.h delete mode 100644 Cantera/src/oneD/Newton1D.h diff --git a/Cantera/src/ArrayViewer.h b/Cantera/src/ArrayViewer.h index fab042751..0e3c9d61b 100755 --- a/Cantera/src/ArrayViewer.h +++ b/Cantera/src/ArrayViewer.h @@ -1,9 +1,8 @@ /** - * @file Array.h - * - * Header file for class Array2D - * - * $Author$ + * @file ArrayViewer.h + */ + +/* $Author$ * $Revision$ * $Date$ * diff --git a/Cantera/src/DenseMatrix.cpp b/Cantera/src/DenseMatrix.cpp index a8bc155c2..0ec8e64f4 100755 --- a/Cantera/src/DenseMatrix.cpp +++ b/Cantera/src/DenseMatrix.cpp @@ -50,9 +50,6 @@ namespace Cantera { } } - /** - * Solve Ax = b. Array b is overwritten on exit with x. - */ int solve(DenseMatrix& A, double* b) { int info=0; ct_dgetrf(static_cast(A.nRows()), @@ -72,7 +69,6 @@ namespace Cantera { return 0; } - /** Solve Ax = b for multiple right-hand-side vectors. */ int solve(DenseMatrix& A, DenseMatrix& b) { int info=0; ct_dgetrf(static_cast(A.nRows()), diff --git a/Cantera/src/EdgeKinetics.h b/Cantera/src/EdgeKinetics.h index 288a189a6..3e54a40e3 100644 --- a/Cantera/src/EdgeKinetics.h +++ b/Cantera/src/EdgeKinetics.h @@ -98,7 +98,6 @@ namespace Cantera { m_redo_rates = true; } - //@} /** * @name Reaction Rates Of Progress */ diff --git a/Cantera/src/GRI_30_Kinetics.h b/Cantera/src/GRI_30_Kinetics.h index 8822c4d13..4e62697fc 100755 --- a/Cantera/src/GRI_30_Kinetics.h +++ b/Cantera/src/GRI_30_Kinetics.h @@ -1,6 +1,6 @@ /** * - * @file GasKinetics.h + * @file GRI_30_Kinetics.h * */ diff --git a/Cantera/src/GasKineticsWriter.h b/Cantera/src/GasKineticsWriter.h index 015475114..05967b104 100755 --- a/Cantera/src/GasKineticsWriter.h +++ b/Cantera/src/GasKineticsWriter.h @@ -1,6 +1,6 @@ /** * - * @file GasKinetics.h + * @file GasKineticsWriter.h * * $Author$ * $Revision$ diff --git a/Cantera/src/InterfaceKinetics.h b/Cantera/src/InterfaceKinetics.h index 0f8ddde82..1c7c52430 100644 --- a/Cantera/src/InterfaceKinetics.h +++ b/Cantera/src/InterfaceKinetics.h @@ -105,9 +105,6 @@ namespace Cantera { m_redo_rates = true; } - //@} - - /// /// @name Reaction Rates Of Progress /// diff --git a/Cantera/src/PureFluidPhase.h b/Cantera/src/PureFluidPhase.h index 71e022826..a5d34060a 100644 --- a/Cantera/src/PureFluidPhase.h +++ b/Cantera/src/PureFluidPhase.h @@ -1,5 +1,5 @@ /** - * @file PureFluid.h + * @file PureFluidPhase.h * * Declares class PureFluid */ diff --git a/Cantera/src/ReactionStoichMgr.h b/Cantera/src/ReactionStoichMgr.h index 7eb667691..0791bb39f 100644 --- a/Cantera/src/ReactionStoichMgr.h +++ b/Cantera/src/ReactionStoichMgr.h @@ -39,24 +39,25 @@ namespace Cantera { * quantities may be called. * * The nomenclature used below to document the methods is as follows. + * * - \f$ N_r \f$ - * - Integer reactant stoichiometric coefficient matrix. The (k,i) + * Integer reactant stoichiometric coefficient matrix. The (k,i) * element of this matrix is the stoichiometric coefficient of * species \i k as a reactant in reaction \i i. * - \f$ N_p \f$ - * - Integer product stoichiometric coefficient matrix. The (k,i) + * Integer product stoichiometric coefficient matrix. The (k,i) * element of this matrix is the stoichiometric coefficient of * species \i k as a product in reaction \i i. * - \f$ Q_{\rm fwd} \f$ - * - Vector of length I of forward rates of progress. + * Vector of length I of forward rates of progress. * - \f$ Q_{\rm rev} \f$ - * - Vector of length I of reverse rates of progress. + * Vector of length I of reverse rates of progress. * - \f$ C \f$ - * - Vector of K species creation rates. + * Vector of K species creation rates. * - \f$ D \f$ - * - Vector of K species destruction rates. + * Vector of K species destruction rates. * - \f$ W = C - D \f$ - * - Vector of K species net production rates. + * Vector of K species net production rates. * */ class ReactionStoichMgr { diff --git a/Cantera/src/SimpleThermo.h b/Cantera/src/SimpleThermo.h index b9d2cba6b..2d534d922 100644 --- a/Cantera/src/SimpleThermo.h +++ b/Cantera/src/SimpleThermo.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ */ diff --git a/Cantera/src/SpeciesThermoMgr.h b/Cantera/src/SpeciesThermoMgr.h index 9b446c84e..7861443a7 100755 --- a/Cantera/src/SpeciesThermoMgr.h +++ b/Cantera/src/SpeciesThermoMgr.h @@ -20,12 +20,6 @@ using namespace std; namespace Cantera { - /////////////////////////////////////////////////////////////// - // - // Helper Template Functions - // - /////////////////////////////////////////////////////////////// - /** * Invokes the 'updateProperties' method of all objects in the * list. @@ -180,8 +174,8 @@ namespace Cantera { map speciesToType; }; -#define REMOVE_FOR_V155 -#ifndef REMOVE_FOR_V155 + //#define REMOVE_FOR_V155 + //#ifndef REMOVE_FOR_V155 /** * This species thermo manager requires that all species have the @@ -246,7 +240,7 @@ namespace Cantera { vector m_thermo; doublereal m_pref; }; -#endif + //#endif } diff --git a/Cantera/src/StoichManager.h b/Cantera/src/StoichManager.h index 8a35c0c08..02c95aeb4 100755 --- a/Cantera/src/StoichManager.h +++ b/Cantera/src/StoichManager.h @@ -376,7 +376,7 @@ namespace Cantera { } - /** + /* * This class handles operations involving the stoichiometric * coefficients on one side of a reaction (reactant or product) for * a set of reactions comprising a reaction mechanism. This class is @@ -393,7 +393,7 @@ namespace Cantera { * r_i = \sum_m^{M_i} s_{k_{m,i}} * \f] * To understand the operations performed by this class, let - * $N_{k,i}$ denote the stoichiometric coefficient of species k on + * \f$ N_{k,i}\f$ denote the stoichiometric coefficient of species k on * one side (reactant or product) in reaction i. Then \b N is a sparse * K by I matrix of stoichiometric coefficients. * diff --git a/Cantera/src/StoichSubstance.h b/Cantera/src/StoichSubstance.h index e850fd8d8..e65481ef8 100644 --- a/Cantera/src/StoichSubstance.h +++ b/Cantera/src/StoichSubstance.h @@ -72,7 +72,7 @@ namespace Cantera { * stoichiometric substance, the molar internal energy is * independent of pressure. Since the thermodynamic properties * are specified by giving the standard-state enthalpy, the - * term \f$ P_0 \hat v$ is subtracted from the specified molar + * term \f$ P_0 \hat v\f$ is subtracted from the specified molar * enthalpy to compute the molar internal energy. */ virtual doublereal intEnergy_mole() const { @@ -99,7 +99,7 @@ namespace Cantera { /** * Molar heat capacity at constant pressure. Units: J/kmol/K. - * For an incompressible substance, \f$ \hat c_p = \hat c_v$. + * For an incompressible substance, \f$ \hat c_p = \hat c_v\f$. */ virtual doublereal cp_mole() const { _updateThermo(); @@ -108,7 +108,7 @@ namespace Cantera { /** * Molar heat capacity at constant volume. Units: J/kmol/K. - * For an incompressible substance, \f$ \hat c_p = \hat c_v$. + * For an incompressible substance, \f$ \hat c_p = \hat c_v\f$. */ virtual doublereal cv_mole() const { return cp_mole(); diff --git a/Cantera/src/ThermoPhase.h b/Cantera/src/ThermoPhase.h index 96bf8e846..1e0b0570e 100755 --- a/Cantera/src/ThermoPhase.h +++ b/Cantera/src/ThermoPhase.h @@ -206,8 +206,9 @@ namespace Cantera { /** * This method returns an array of generalized concentrations - * \f$ C_k \f$ that are defined such that \f$ a_k = C_k / - * C^0_k, \f$ where \f$ C^0_k \f$ is a standard concentration + * \f$ C_k\f$ that are defined such that + * \f$ a_k = C_k / C^0_k, \f$ where \f$ C^0_k \f$ + * is a standard concentration * defined below. These generalized concentrations are used * by kinetics manager classes to compute the forward and * reverse rates of elementary reactions. @@ -245,8 +246,8 @@ namespace Cantera { return -1.0; } - /** Get the array of chemical potentials at unit activity \f$ - * \mu^0_k \f$. + /** Get the array of chemical potentials at unit activity + * \f$ \mu^0_k \f$. */ virtual void getStandardChemPotentials(doublereal* mu) const { err("getStandardChemPotentials"); @@ -274,8 +275,8 @@ namespace Cantera { int sizeUA = 6); /** - * Get the array of non-dimensional chemical potentials \f$ - * \mu_k / \hat R T \f$. + * Get the array of non-dimensional chemical potentials + * \f$ \mu_k / \hat R T \f$. */ virtual void getChemPotentials_RT(doublereal* mu) const { err("getChemPotentials_RT"); @@ -290,7 +291,7 @@ namespace Cantera { /** * Get the species electrochemical potentials. Units: J/kmol. - * This method adds a term \f$ Fz_k \phi_k$ to the + * This method adds a term \f$ Fz_k \phi_k \f$ to the * to each chemical potential. */ void getElectrochemPotentials(doublereal* mu) const { @@ -432,7 +433,6 @@ namespace Cantera { } //@} - /// @internal doublereal _RT() const { return temperature() * GasConstant; } @@ -491,15 +491,17 @@ namespace Cantera { //@} /** - * @internal * @name Chemical Equilibrium + * Chemical equilibrium. * @{ - * + */ + + /** * This method is used by the ChemEquil equilibrium solver. * It sets the state such that the chemical potentials satisfy * \f[ \frac{\mu_k}{\hat R T} = \sum_m A_{k,m} - * \left(\frac{\lambda_m} {\hat R T}\right) \f] where \f$ - * \lambda_m \f$ is the element potential of element m. The + * \left(\frac{\lambda_m} {\hat R T}\right) \f] where + * \f$ \lambda_m \f$ is the element potential of element m. The * temperature is unchanged. Any phase (ideal or not) that * implements this method can be equilibrated by ChemEquil. */ diff --git a/Cantera/src/converters/CKParser.cpp b/Cantera/src/converters/CKParser.cpp index 994c7e77e..72cfe6d5b 100755 --- a/Cantera/src/converters/CKParser.cpp +++ b/Cantera/src/converters/CKParser.cpp @@ -6,7 +6,10 @@ // Copyright 2001 California Institute of Technology // // $Log$ -// Revision 1.12 2004-08-05 14:56:57 dggoodwin +// Revision 1.13 2004-08-28 16:12:41 dggoodwin +// cleanup +// +// Revision 1.12 2004/08/05 14:56:57 dggoodwin // *** empty log message *** // // Revision 1.11 2004/07/27 14:22:31 dggoodwin @@ -76,9 +79,6 @@ namespace ckr { static int parseGroupString(string str, vector& esyms, vector_int& result); - /// @internal - //static string dummy_string; - /** * Throw an exception if one of the four lines that must have * 1, 2, 3, or 4 in column 80 do not. diff --git a/Cantera/src/converters/Group.h b/Cantera/src/converters/Group.h index 6cb1ff504..2c2e4054f 100755 --- a/Cantera/src/converters/Group.h +++ b/Cantera/src/converters/Group.h @@ -1,5 +1,5 @@ /** - * @file Element.h + * @file converters/Group.h * */ diff --git a/Cantera/src/converters/Reaction.h b/Cantera/src/converters/Reaction.h index 51468d6e0..89e15260a 100755 --- a/Cantera/src/converters/Reaction.h +++ b/Cantera/src/converters/Reaction.h @@ -247,11 +247,7 @@ namespace ckr { Reaction forwardReaction(const Reaction& rxn); Reaction reverseReaction(const Reaction& rxn); } -/** - * @file Reaction.h - * Definitions of reaction-related classes. - * @author California Institute of Technology, Caltech - */ + diff --git a/Cantera/src/converters/atomicWeightDB.cpp b/Cantera/src/converters/atomicWeightDB.cpp index 33980d7fe..8a8965b94 100755 --- a/Cantera/src/converters/atomicWeightDB.cpp +++ b/Cantera/src/converters/atomicWeightDB.cpp @@ -1,5 +1,5 @@ /** - * @file atomicWeightsDB.cpp + * @file atomicWeightDB.cpp * * internal database of default atomic weights * @@ -13,9 +13,7 @@ #pragma warning(disable:4786) #endif -//#include "../../config.h" #include -//#include "../Cantera/src/ctmap.h" #include #include using namespace std; diff --git a/Cantera/src/converters/config.h b/Cantera/src/converters/config.h index 054804c33..3f332cbf4 100755 --- a/Cantera/src/converters/config.h +++ b/Cantera/src/converters/config.h @@ -13,12 +13,6 @@ namespace ckr { } -/** - * @file config.h - * Header file generated by configure script. To change options, - * edit config.h.in and re-run configure. - * @author David G. Goodwin, Caltech - */ #endif diff --git a/Cantera/src/converters/filter.cpp b/Cantera/src/converters/filter.cpp index eab97b2da..baf325483 100755 --- a/Cantera/src/converters/filter.cpp +++ b/Cantera/src/converters/filter.cpp @@ -1,5 +1,5 @@ /** - * @file importCK.cpp + * @file filter.cpp * */ diff --git a/Cantera/src/converters/thermoFunctions.cpp b/Cantera/src/converters/thermoFunctions.cpp index e066e20ba..fa2ee68d1 100755 --- a/Cantera/src/converters/thermoFunctions.cpp +++ b/Cantera/src/converters/thermoFunctions.cpp @@ -11,13 +11,6 @@ #pragma warning(disable:4786) #endif -/** - * @file thermoFunctions.cpp - * Species thermodynamic properties implementation. - * @author California Institute of Technology, Caltech - * @date @today - */ - #include #include "thermoFunctions.h" #include diff --git a/Cantera/src/newton_utils.cpp b/Cantera/src/newton_utils.cpp deleted file mode 100755 index 8a1f4e9df..000000000 --- a/Cantera/src/newton_utils.cpp +++ /dev/null @@ -1,102 +0,0 @@ -/** - * @file newton_utils.cpp - */ - -#ifdef WIN32 -#pragma warning(disable:4786) -#pragma warning(disable:4503) -#endif - -#include "ct_defs.h" -#include "Resid1D.h" - -namespace Cantera { - - class Indx { - public: - Indx(int nv, int np) : m_nv(nv), m_np(np) {} - int m_nv, m_np; - int operator()(int m, int j) { return j*m_nv + m; } - }; - - - doublereal bound_step(const doublereal* x, const doublereal* step, - Resid1D& r, int loglevel=0) { - - char buf[100]; - int np = r.nPoints(); - int nv = r.nComponents(); - Indx index(nv, np); - doublereal above, below, val, newval; - int m, j; - doublereal fbound = 1.0; - bool wroteTitle = false; - for (m = 0; m < nv; m++) { - above = r.upperBound(m); - below = r.lowerBound(m); - - for (j = 0; j < np; j++) { - val = x[index(m,j)]; - if (loglevel > 0) { - if (val > above + Tiny || val < below - Tiny) - cout << "ERROR: solution out of bounds. " - << r.componentName(m) << "(" << j << ") = " << val - << " (" << below << ", " << above << ")" << endl; - } - - newval = val + step[index(m,j)]; - - if (newval > above) { - fbound = fmaxx( 0.0, fminn( fbound, - (above - val)/(newval - val))); - } - else if (newval < below) { - fbound = fminn(fbound, (val - below)/(val - newval)); - } - - if (loglevel > 1 && (newval > above || newval < below)) { - if (!wroteTitle) { - writelog("\nNewton step takes solution out of bounds.\n\n"); - sprintf(buf," %12s %4s %10s %10s %10s %10s\n", - "component","pt","value","step","min","max"); - wroteTitle = true; - writelog(buf); - } - sprintf(buf, " %12s %4i %10.3e %10.3e %10.3e %10.3e\n", - r.componentName(m).c_str(), j, val, - step[index(m,j)], below, above); - writelog(buf); - } - } - } - return fbound; - } - - - doublereal norm_square(const doublereal* x, - const doublereal* step, Resid1D& r) { - doublereal f, ewt, esum, sum = 0.0; - int n, j; - - int nv = r.nComponents(); - int np = r.nPoints(); - //int jmx = 0, nmx = 0; - //doublereal fmx = -1.0; - - for (n = 0; n < nv; n++) { - esum = 0.0; - for (j = 0; j < np; j++) esum += fabs(x[nv*j + n]); - ewt = r.rtol(n)*esum/np + r.atol(n); - for (j = 0; j < np; j++) { - f = step[nv*j + n]/ewt; - sum += f*f; -// if (fabs(f) > fmx) { -// fmx = fabs(f); -// jmx = j; -// nmx = n; -// } - } - } - return sum; - } -} diff --git a/Cantera/src/oneD/Jac1D.h b/Cantera/src/oneD/Jac1D.h deleted file mode 100644 index a68b22b2a..000000000 --- a/Cantera/src/oneD/Jac1D.h +++ /dev/null @@ -1,88 +0,0 @@ -/** - * - * @file Jac1D.h - * - * >>>>> Under construction! <<<<< - * - * $Author$ - * $Date$ - * $Revision$ - * - * Copyright 2002 California Institute of Technology - * - */ - -#ifndef CT_JAC1D_H -#define CT_JAC1D_H - -#include "Domain1D.h" -#include "BandMatrix.h" -//#include "ArrayViewer.h" -#include "Array.h" -#include "time.h" - -namespace Cantera { - - /** - * Class Jac1D evaluates the Jacobian of a system of equations - * defined by a residual function of class Domain1D. It is - * assumed that the Jacobian is banded. - */ - class Jac1D : public BandMatrix { - - public: - - /** - * Constructor. The residual function defining the system of - * equations must be supplied. - */ - Jac1D(Domain1D& r); - - /// Destructor. Does nothing. - virtual ~Jac1D(){} - - /** - * Evaluate the Jacobian. - */ - void eval(doublereal* x0, doublereal* resid0); - - /** - * Returns the matrix element describing the influence of the - * nth component at point j on the mth equation at point - * i. Due to the assumption of a banded Jacobian, this will be - * zero unless |i - j| <= 1. - */ - doublereal& v(int m, int i, int n, int j) { - return value(i*m_nv + m, j*m_nv + n); - } - - doublereal elapsedTime() const { - return m_elapsed; - } - - int nEvals() const { return m_nevals; } - - int age() const { return m_age; } - - void incrementAge() { m_age++; } - void setAge(int age) { m_age = age; } - - protected: - - Domain1D* m_resid; - Array2D m_r1; - // ArrayViewer m_x0, m_r0; - int m_nv, m_points; - doublereal m_atol; - doublereal m_elapsed; - int m_nevals; - int m_age; - - private: - size_t index(int m, int j) { return m_nv*j + m; } - }; -} - -#endif - - diff --git a/Cantera/src/oneD/Newton1D.h b/Cantera/src/oneD/Newton1D.h deleted file mode 100644 index 9d030045a..000000000 --- a/Cantera/src/oneD/Newton1D.h +++ /dev/null @@ -1,73 +0,0 @@ -/** - * - * @file Newton1D.h - * - * Newton solver >>> under construction! <<<< - * - * $Author$ - * $Date$ - * $Revision$ - * - * Copyright 2002 California Institute of Technology - * - */ - -#ifndef CT_NEWTON1D_H -#define CT_NEWTON1D_H - -#include "Jac1D.h" - -namespace Cantera { - - class Newton1D { - - public: - - Newton1D(int nv, int np); - virtual ~Newton1D(); - - doublereal norm(const doublereal* step); - void step(doublereal* x, doublereal* step, - Domain1D& r, Jac1D& jac, int loglevel, int update=1); - doublereal boundStep(const doublereal* x0, const doublereal* step0, - const Domain1D& r, int loglevel); - int dampStep(const doublereal* x0, const doublereal* step0, - doublereal* x1, doublereal* step1, doublereal& s1, - Domain1D& r, Jac1D& jac, int loglevel, bool writetitle); - void getErrorWeights(const doublereal* x, doublereal* ewt, Domain1D& r); - doublereal norm2(const doublereal* step, doublereal* ewt); - doublereal norm_infty(const doublereal* step, doublereal* ewt); - int solve(doublereal* x0, doublereal* x1, Domain1D& r, Jac1D& jac, - int loglevel); - int timeIntegrate(int n, doublereal dt, - doublereal* x0, doublereal* x1, - Domain1D& r, Jac1D& jac, int loglevel); - doublereal ssnorm(doublereal* x, doublereal* resid, Domain1D& r); - - void setOptions(int maxJacAge = 5, doublereal maxNormRatio = 0.001) { - m_maxAge = maxJacAge; - m_maxRatio = maxNormRatio; - } - void resize(int points); - - protected: - - doublereal* getWorkArray(); - void releaseWorkArray(doublereal* work); - vector m_workarrays; - vector_fp m_ewt; - int m_maxAge; - int m_maxRatio; - int m_nv, m_np, m_n; - - private: - - size_t index(int n, int j) { - return m_nv * j + n; - } - }; -} - -#endif - - diff --git a/Cantera/src/oneD/Solid1D.cpp b/Cantera/src/oneD/Solid1D.cpp index a55cbe256..cfdb5d8a3 100644 --- a/Cantera/src/oneD/Solid1D.cpp +++ b/Cantera/src/oneD/Solid1D.cpp @@ -1,5 +1,5 @@ /** - * @file Solid.cpp + * @file Solid1D.cpp */ /* diff --git a/Cantera/src/oneD/newton_utils.cpp b/Cantera/src/oneD/newton_utils.cpp index 75afae534..4690d9177 100644 --- a/Cantera/src/oneD/newton_utils.cpp +++ b/Cantera/src/oneD/newton_utils.cpp @@ -86,8 +86,8 @@ namespace Cantera { * * @param x Solution vector for this domain. * @param step Newton step vector for this domain. - * @param r Object representing the domain. Used to get tolerances, number of components, - * and number of points. + * @param r Object representing the domain. Used to get tolerances, + * number of components, and number of points. * * The return value is * \f[ @@ -98,10 +98,10 @@ namespace Cantera { * w_n = \epsilon_{r,n} \frac{\sum_j |x_{n,j}|}{J} + \epsilon_{a,n}. * \f] * Here \f$\epsilon_{r,n} \f$ is the relative error tolerance for - * component \f$ n \f$, and multiplies the average magnitude of - * solution component n in the domain. The second term, \f$ - * \epsilon_{a,n}$, is the absolute error tolerance for component - * \f$ n \f$. + * component n, and multiplies the average magnitude of + * solution component n in the domain. The second term, + * \f$\epsilon_{a,n}\f$, is the absolute error tolerance for component + * n. * */ doublereal norm_square(const doublereal* x, diff --git a/Cantera/src/zeroD/Reactor.cpp b/Cantera/src/zeroD/Reactor.cpp index a261523d7..fad757d10 100644 --- a/Cantera/src/zeroD/Reactor.cpp +++ b/Cantera/src/zeroD/Reactor.cpp @@ -88,7 +88,7 @@ namespace Cantera { } - /** + /* * Must be called before calling method 'advance' */ void Reactor::initialize(doublereal t0) { @@ -181,7 +181,7 @@ namespace Cantera { evalEqs(time, y, ydot); } - /** + /* * Called by the integrator to evaluate ydot given y at time 'time'. */ void Reactor::evalEqs(doublereal time, doublereal* y, doublereal* ydot) @@ -255,10 +255,12 @@ namespace Cantera { } - /** + /* * Energy equation. - * \dot U = -P\dot V + A \dot q + \dot m_{in} h_{in} + * \f[ + * \dot U = -P\dot V + A \dot q + \dot m_{in} h_{in} * - \dot m_{out} h. + * \f] */ if (m_energy) { ydot[0] = - m_thermo->pressure() * m_vdot - m_Q; diff --git a/Cantera/src/zeroD/Reservoir.h b/Cantera/src/zeroD/Reservoir.h index 3d43ec53e..0779f3eed 100644 --- a/Cantera/src/zeroD/Reservoir.h +++ b/Cantera/src/zeroD/Reservoir.h @@ -1,5 +1,5 @@ /** - * @file Reqservoir.h + * @file Reservoir.h */ /*