GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Replace remaining Doxygen commands

Browse Source
This commit is contained in:
Ingmar Schoegl 2023-08-02 13:00:06 -05:00
parent d92d977ca9
commit 070c226fba
23 changed files with 127 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/cantera/base/Array.h
View File

@ -52,7 +52,7 @@ public:
//! Constructor.
/*!
* Create an \c m by \c n array, and initialize all elements to \c v.
* Create an @c m by @c n array, and initialize all elements to @c v.
*
* @param m Number of rows
* @param n Number of columns
@ -62,8 +62,8 @@ public:
//! Constructor.
/*!
* Create an \c m by \c n array, initialized with the contents of the array
* \c values.
* Create an @c m by @c n array, initialized with the contents of the array
* @c values.
*
* @param m Number of rows
* @param n Number of columns

12
include/cantera/base/global.h
View File

@ -39,13 +39,13 @@ class AnyMap;
* for input files along a path that includes platform-specific default
* locations, and possibly user-specified locations:
*
* - The current directory \c "." is always searched first. Then, on Windows, the
* - The current directory @c "." is always searched first. Then, on Windows, the
* registry is checked to find the %Cantera installation directory, and the
* \c data subdirectory of the installation directory will be added to the search
* @c data subdirectory of the installation directory will be added to the search
* path.
* - On any platform, if environment variable \c CANTERA_DATA is set to a directory
* - On any platform, if environment variable @c CANTERA_DATA is set to a directory
* name or a list of directory names separated with the OS-dependent path
* separator (that is, \c ";" on Windows, \c ":" elsewhere), then these directories
* separator (that is, @c ";" on Windows, @c ":" elsewhere), then these directories
* will be added to the search path.
* - Finally, the location where the data files were installed when %Cantera was
* built is added to the search path.
@ -116,7 +116,7 @@ bool usingSharedLibrary();
//! @{
//! Returns the %Cantera version. This function is used to access the version from a
//! library, rather than the \c CANTERA_VERSION macro that is available at compile time.
//! library, rather than the @c CANTERA_VERSION macro that is available at compile time.
//! @since New in %Cantera 3.0
string version();
@ -130,7 +130,7 @@ string gitCommit();
//! preprocessor macro is defined.
bool debugModeEnabled();
//! Returns true if %Cantera was compiled with C++ \c HDF5 support.
//! Returns true if %Cantera was compiled with C++ @c HDF5 support.
//! @since New in %Cantera 3.0.
bool usesHDF5();

4
include/cantera/base/utilities.h
View File

@ -29,7 +29,7 @@ namespace Cantera
//! Templated Inner product of two vectors of length 4.
/*!
* If either \a x or \a y has length greater than 4, only the first 4 elements
* If either @e x or @e y has length greater than 4, only the first 4 elements
* will be used.
*
* @param x first reference to the templated class V
@ -44,7 +44,7 @@ inline double dot4(const V& x, const V& y)
//! Templated Inner product of two vectors of length 5
/*!
* If either \a x or \a y has length greater than 4, only the first 4 elements
* If either @e x or @e y has length greater than 4, only the first 4 elements
* will be used.
*
* @param x first reference to the templated class V

42
include/cantera/equil/MultiPhase.h
View File

@ -113,7 +113,7 @@ public:
*/
string elementName(size_t m) const;
//! Returns the index of the element with name \a name.
//! Returns the index of the element with name @e name.
/*!
* @param name String name of the global element
*/
@ -133,14 +133,14 @@ public:
//! which take an array pointer.
void checkSpeciesArraySize(size_t kk) const;
//! Name of species with global index \a kGlob
//! Name of species with global index @e kGlob
/*!
* @param kGlob global species index
*/
string speciesName(const size_t kGlob) const;
//! Returns the Number of atoms of global element \a mGlob in
//! global species \a kGlob.
//! Returns the Number of atoms of global element @e mGlob in
//! global species @e kGlob.
/*!
* @param kGlob global species index
* @param mGlob global element index
@ -151,7 +151,7 @@ public:
//! Returns the global Species mole fractions.
/*!
* Write the array of species mole
* fractions into array \c x. The mole fractions are
* fractions into array @c x. The mole fractions are
* normalized to sum to one in each phase.
*
* @param x vector of mole fractions. Length = number of global species.
@ -211,14 +211,14 @@ public:
//! which take an array pointer.
void checkPhaseArraySize(size_t mm) const;
//! Returns the moles of global species \c k. units = kmol
//! Returns the moles of global species @c k. units = kmol
/*!
* @param kGlob Global species index k
*/
double speciesMoles(size_t kGlob) const;
//! Return the global index of the species belonging to phase number \c p
//! with local index \c k within the phase.
//! Return the global index of the species belonging to phase number @c p
//! with local index @c k within the phase.
/*!
* @param k local index of the species within the phase
* @param p index of the phase
@ -227,8 +227,8 @@ public:
return m_spstart[p] + k;
}
//! Return the global index of the species belonging to phase name \c phaseName
//! with species name \c speciesName
//! Return the global index of the species belonging to phase name @c phaseName
//! with species name @c speciesName
/*!
* @param speciesName Species Name
* @param phaseName Phase Name
@ -257,15 +257,15 @@ public:
//! Total charge summed over all phases (Coulombs).
double charge() const;
//! Charge (Coulombs) of phase with index \a p.
//! Charge (Coulombs) of phase with index @e p.
/*!
* The net charge is computed as @f[ Q_p = N_p \sum_k F z_k X_k @f]
* where the sum runs only over species in phase \a p.
* where the sum runs only over species in phase @e p.
* @param p index of the phase for which the charge is desired.
*/
double phaseCharge(size_t p) const;
//! Total moles of global element \a m, summed over all phases.
//! Total moles of global element @e m, summed over all phases.
/*!
* @param m Index of the global element
*/
@ -273,7 +273,7 @@ public:
//! Returns a vector of Chemical potentials.
/*!
* Write into array \a mu the chemical potentials of all species
* Write into array @e mu the chemical potentials of all species
* [J/kmol]. The chemical potentials are related to the activities by
*
* @f$
@ -287,16 +287,16 @@ public:
//! Returns a vector of Valid chemical potentials.
/*!
* Write into array \a mu the chemical potentials of all species with
* Write into array @e mu the chemical potentials of all species with
* thermo data valid for the current temperature [J/kmol]. For other
* species, set the chemical potential to the value \a not_mu. If \a
* species, set the chemical potential to the value @e not_mu. If @e
* standard is set to true, then the values returned are standard chemical
* potentials.
*
* This method is designed for use in computing chemical equilibrium by
* Gibbs minimization. For solution phases (more than one species), this
* does the same thing as getChemPotentials. But for stoichiometric
* phases, this writes into array \a mu the user-specified value \a not_mu
* phases, this writes into array @e mu the user-specified value @e not_mu
* instead of the chemical potential if the temperature is outside the
* range for which the thermo data for the one species in the phase are
* valid. The need for this arises since many condensed phases have thermo
@ -307,7 +307,7 @@ public:
* result in spurious chemical potentials, and can lead to condensed
* phases appearing when in fact they should be absent.
*
* By setting \a not_mu to a large positive value, it is possible to force
* By setting @e not_mu to a large positive value, it is possible to force
* routines which seek to minimize the Gibbs free energy of the mixture to
* zero out any phases outside the temperature range for which their
* thermo data are valid.
@ -316,7 +316,7 @@ public:
* for which the thermo data is not valid
* @param mu Vector of chemical potentials. length = Global species,
* units = J kmol-1
* @param standard If this method is called with \a standard set to true,
* @param standard If this method is called with @e standard set to true,
* then the composition-independent standard chemical
* potentials are returned instead of the composition-
* dependent chemical potentials.
@ -426,7 +426,7 @@ public:
return m_phase.size();
}
//! Return true is species \a kGlob is a species in a multicomponent
//! Return true is species @e kGlob is a species in a multicomponent
//! solution phase.
/*!
* @param kGlob index of the global species
@ -506,7 +506,7 @@ public:
*/
void getElemAbundances(double* elemAbundances) const;
//! Return true if the phase \a p has valid thermo data for the current
//! Return true if the phase @e p has valid thermo data for the current
//! temperature.
/*!
* @param p Index of the phase.

2
include/cantera/equil/MultiPhaseEquil.h
View File

@ -96,7 +96,7 @@ protected:
//! The component species are taken to be the first M species in array
//! 'species' that have linearly-independent compositions.
//!
//! @param order On entry, vector \a order should contain species index
//! @param order On entry, vector @e order should contain species index
//! numbers in the order of decreasing desirability as a component.
//! For example, if it is desired to choose the components from among
//! the major species, this array might list species index numbers in

4
include/cantera/equil/vcs_VolPhase.h
View File

@ -423,13 +423,13 @@ public:
//! Returns the number of element constraints
size_t nElemConstraints() const;
//! Name of the element constraint with index \c e.
//! Name of the element constraint with index @c e.
/*!
* @param e Element index.
*/
string elementName(const size_t e) const;
//! Type of the element constraint with index \c e.
//! Type of the element constraint with index @c e.
/*!
* @param e Element index.
*/

2
include/cantera/kinetics/Kinetics.h
View File

@ -419,7 +419,7 @@ public:
* @f]
* For example, if this method is called with the array of standard-state
* molar Gibbs free energies for the species, then the values returned in
* array \c deltaProperty would be the standard-state Gibbs free energies of
* array @c deltaProperty would be the standard-state Gibbs free energies of
* reaction for each reaction.
*
* @param property Input vector of property value. Length: #m_kk.

10
include/cantera/kinetics/ReactionPath.h
View File

@ -84,7 +84,7 @@ public:
typedef map<size_t, double> rxn_path_map;
/**
* Constructor. Construct a one-way path from \c begin to \c end.
* Constructor. Construct a one-way path from @c begin to @c end.
*/
Path(SpeciesNode* begin, SpeciesNode* end);
@ -114,7 +114,7 @@ public:
}
/**
* If \c n is one of the nodes this path connects, then
* If @c n is one of the nodes this path connects, then
* the other node is returned. Otherwise zero is returned.
*/
SpeciesNode* otherNode(SpeciesNode* n) {
@ -171,12 +171,12 @@ public:
return m_flxmax;
}
//! The net flow from node \c k1 to node \c k2
//! The net flow from node @c k1 to node @c k2
double netFlow(size_t k1, size_t k2) {
return flow(k1, k2) - flow(k2, k1);
}
//! The one-way flow from node \c k1 to node \c k2
//! The one-way flow from node @c k1 to node @c k2
double flow(size_t k1, size_t k2) {
return (m_paths[k1][k2] ? m_paths[k1][k2]->flow() : 0.0);
}
@ -190,7 +190,7 @@ public:
/**
* Export the reaction path diagram. This method writes to stream
* \c s the commands for the 'dot' program in the \c GraphViz
* @c s the commands for the 'dot' program in the @c GraphViz
* package from AT&T. (GraphViz may be downloaded from www.graphviz.org.)
*
* To generate a postscript reaction path diagram from the output of this

6
include/cantera/kinetics/StoichManager.h
View File

@ -37,7 +37,7 @@ namespace Cantera
* @f]
*
* where @f$ \nu^{(p)_{k,i}} @f$ is the product-side stoichiometric
* coefficient of species \a k in reaction \a i. This could be done by
* coefficient of species @e k in reaction @e i. This could be done by
* straightforward matrix multiplication, but would be inefficient, since most
* of the matrix elements of @f$ \nu^{(p)}_{k,i} @f$ are zero. We could do
* better by using sparse-matrix algorithms to compute this product.
@ -563,7 +563,7 @@ inline static void _scale(InputIter begin, InputIter end,
* @f]
* To understand the operations performed by this class, let @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
* product) in reaction i. Then @b N is a sparse K by I matrix of stoichiometric
* coefficients.
*
* The following matrix operations may be carried out with a vector S of length
@ -576,7 +576,7 @@ inline static void _scale(InputIter begin, InputIter end,
*
* The actual implementation, however, does not compute these quantities by
* matrix multiplication. A faster algorithm is used that makes use of the fact
* that the \b integer-valued N matrix is very sparse, and the non-zero terms
* that the @b integer-valued N matrix is very sparse, and the non-zero terms
* are small positive integers.
* @f[
* S_k = R_{i1} + \dots + R_{iM}

6
include/cantera/numerics/BandMatrix.h
View File

@ -38,14 +38,14 @@ class BandMatrix : public GeneralMatrix
public:
//! Base Constructor
/*!
* Create an \c 0 by \c 0 matrix, and initialize all elements to \c 0.
* Create an @c 0 by @c 0 matrix, and initialize all elements to @c 0.
*/
BandMatrix();
~BandMatrix();
//! Creates a banded matrix and sets all elements to zero
/*!
* Create an \c n by \c n banded matrix, and initialize all elements to \c v.
* Create an @c n by @c n banded matrix, and initialize all elements to @c v.
*
* @param n size of the square matrix
* @param kl band size on the lower portion of the matrix
@ -131,7 +131,7 @@ public:
//! Return the number of rows of storage needed for the band storage
size_t ldim() const;
//! Multiply A*b and write result to \c prod.
//! Multiply A*b and write result to @c prod.
virtual void mult(const double* b, double* prod) const;
virtual void leftMult(const double* const b, double* const prod) const;

8
include/cantera/numerics/DenseMatrix.h
View File

@ -59,7 +59,7 @@ public:
//! Constructor.
/*!
* Create an \c n by \c m matrix, and initialize all elements to \c v.
* Create an @c n by @c m matrix, and initialize all elements to @c v.
*
* @param n New number of rows
* @param m New number of columns
@ -93,7 +93,7 @@ public:
virtual void mult(const double* b, double* prod) const;
//! Multiply A*B and write result to \c prod.
//! Multiply A*B and write result to @c prod.
/*!
* Take this matrix to be of size NxM.
* @param[in] b DenseMatrix B of size MxP
@ -188,7 +188,7 @@ int solve(DenseMatrix& A, double* b, size_t nrhs=1, size_t ldb=0);
*/
int solve(DenseMatrix& A, DenseMatrix& b);
//! Multiply \c A*b and return the result in \c prod. Uses BLAS routine DGEMV.
//! Multiply @c A*b and return the result in @c prod. Uses BLAS routine DGEMV.
/*!
* @f[
* prod_i = sum^N_{j = 1}{A_{ij} b_j}
@ -200,7 +200,7 @@ int solve(DenseMatrix& A, DenseMatrix& b);
*/
void multiply(const DenseMatrix& A, const double* const b, double* const prod);
//! Multiply \c A*b and add it to the result in \c prod. Uses BLAS routine DGEMV.
//! Multiply @c A*b and add it to the result in @c prod. Uses BLAS routine DGEMV.
/*!
* @f[
* prod_i += sum^N_{j = 1}{A_{ij} b_j}

92
include/cantera/numerics/Func1.h
View File

@ -49,39 +49,39 @@ class TimesConstant1;
//! Simple functors implement standard mathematical expressions with a single
//! parameter.
//! The following simple functor types are implemented:
//! - \c "sin" (class Sin1), \c "cos" (class Cos1),
//! - \c "exp" (class Exp1), \c "log" (class Log1),
//! - \c "pow" (class Pow1),
//! - \c "constant" (class Const1).
//! - @c "sin" (class Sin1), @c "cos" (class Cos1),
//! - @c "exp" (class Exp1), @c "log" (class Log1),
//! - @c "pow" (class Pow1),
//! - @c "constant" (class Const1).
//! @ingroup func1
//! @defgroup func1advanced Advanced Functors
//! Advanced functors implement expressions that require multiple parameters.
//! The following advanced functor types are implemented:
//! - \c "tabulated-linear" and \c "tabulated-previous" (class Tabulated1),
//! - \c "polynomial" (class Poly1),
//! - \c "Fourier" (class Fourier1),
//! - \c "Gaussian" (class Gaussian1),
//! - \c "Arrhenius" (class Arrhenius1).
//! - @c "tabulated-linear" and @c "tabulated-previous" (class Tabulated1),
//! - @c "polynomial" (class Poly1),
//! - @c "Fourier" (class Fourier1),
//! - @c "Gaussian" (class Gaussian1),
//! - @c "Arrhenius" (class Arrhenius1).
//! @ingroup func1
//! @defgroup func1compound Compound Functors
//! Compound functors implement expressions that are composed of other functors.
//! The following compound functor types are implemented:
//! - \c "sum" (class Sum1),
//! - \c "diff" (class Diff1),
//! - \c "product" (class Product1),
//! - \c "ratio" (class Ratio1),
//! - \c "composite" (class Composite1),
//! - @c "sum" (class Sum1),
//! - @c "diff" (class Diff1),
//! - @c "product" (class Product1),
//! - @c "ratio" (class Ratio1),
//! - @c "composite" (class Composite1),
//! @ingroup func1
//! @defgroup func1modified Modified Functors
//! Modified functors implement expressions that involve one functor and
//! a single parameter.
//! The following modified functor types are implemented:
//! - \c "times-constant" (class TimesConstant1),
//! - \c "plus-constant" (class PlusConstant1),
//! - \c "periodic" (class Periodic1).
//! - @c "times-constant" (class TimesConstant1),
//! - @c "plus-constant" (class PlusConstant1),
//! - @c "periodic" (class Periodic1).
//! @ingroup func1
//! @defgroup func1helper Helper Functions
@ -264,9 +264,9 @@ shared_ptr<Func1> newTimesConstFunction(shared_ptr<Func1> f1, double c);
//! @ingroup func1helper
shared_ptr<Func1> newPlusConstFunction(shared_ptr<Func1> f1, double c);
//! Implements the \c sin() function.
//! Implements the @c sin() function.
/*!
* The functor class with type \c "sin" returns @f$ f(x) = \cos(\omega x) @f$,
* The functor class with type @c "sin" returns @f$ f(x) = \cos(\omega x) @f$,
* where the argument @f$ x @f$ is in radians.
* @param omega Frequency @f$ \omega @f$ (default=1.0)
* @ingroup func1simple
@ -313,9 +313,9 @@ public:
};
//! Implements the \c cos() function.
//! Implements the @c cos() function.
/*!
* The functor class with type \c "cos" returns @f$ f(x) = \cos(\omega x) @f$,
* The functor class with type @c "cos" returns @f$ f(x) = \cos(\omega x) @f$,
* where the argument @f$ x @f$ is in radians.
* @param omega Frequency @f$ \omega @f$ (default=1.0)
* @ingroup func1simple
@ -359,9 +359,9 @@ public:
};
//! Implements the \c exp() (exponential) function.
//! Implements the @c exp() (exponential) function.
/*!
* The functor class with type \c "exp" returns @f$ f(x) = \exp(a x) @f$.
* The functor class with type @c "exp" returns @f$ f(x) = \exp(a x) @f$.
* @param a Factor (default=1.0)
* @ingroup func1simple
*/
@ -403,9 +403,9 @@ public:
};
//! Implements the \c log() (natural logarithm) function.
//! Implements the @c log() (natural logarithm) function.
/*!
* The functor class with type \c "log" returns @f$ f(x) = \log(a x) @f$.
* The functor class with type @c "log" returns @f$ f(x) = \log(a x) @f$.
* @param a Factor (default=1.0)
* @ingroup func1simple
* @since New in %Cantera 3.0
@ -433,9 +433,9 @@ public:
virtual string write(const string& arg) const;
};
//! Implements the \c pow() (power) function.
//! Implements the @c pow() (power) function.
/*!
* The functor class with type \c "pow" returns @f$ f(x) = x^n @f$.
* The functor class with type @c "pow" returns @f$ f(x) = x^n @f$.
* @param n Exponent
* @ingroup func1simple
*/
@ -477,12 +477,12 @@ public:
//! Implements a tabulated function.
/*!
* The functor class is based on tabulated arrays \c tvals and \c fvals, where
* \c tvals contain independent variables and \c fvals are corresponding function
* The functor class is based on tabulated arrays @c tvals and @c fvals, where
* @c tvals contain independent variables and @c fvals are corresponding function
* values. Depending on configuration, the function is either interpolated linearly
* between the tabulated points (type \c "tabulated-linear" ; default), or yields
* between the tabulated points (type @c "tabulated-linear" ; default), or yields
* the last tabulated value until a new tabulated time value is reached (type
* \c "tabulated-previous" ).
* @c "tabulated-previous" ).
* @ingroup func1advanced
*/
class Tabulated1 : public Func1
@ -503,8 +503,8 @@ public:
Tabulated1(const vector<double>& params);
//! Set the interpolation method
//! @param method Evaluation method. If \c "linear" (default), a linear
//! interpolation between tabulated values is used; if \c "previous", the
//! @param method Evaluation method. If @c "linear" (default), a linear
//! interpolation between tabulated values is used; if @c "previous", the
//! last tabulated value is held until a new tabulated time value is reached.
//! @since New in %Cantera 3.0
void setMethod(const string& method);
@ -533,7 +533,7 @@ private:
//! Implements a constant.
/*!
* The functor class with type \c "constant" returns @f$ f(x) = a @f$.
* The functor class with type @c "constant" returns @f$ f(x) = a @f$.
* @param a Constant
* @ingroup func1simple
*/
@ -580,7 +580,7 @@ public:
/**
* Implements the sum of two functions.
* The functor class with type \c "sum" returns @f$ f(x) = f_1(x) + f_2(x) @f$.
* The functor class with type @c "sum" returns @f$ f(x) = f_1(x) + f_2(x) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param f2 Functor @f$ f_2(x) @f$
* @ingroup func1compound
@ -651,7 +651,7 @@ public:
/**
* Implements the difference of two functions.
* The functor class with type \c "diff" returns @f$ f(x) = f_1(x) - f_2(x) @f$.
* The functor class with type @c "diff" returns @f$ f(x) = f_1(x) - f_2(x) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param f2 Functor @f$ f_2(x) @f$
* @ingroup func1compound
@ -724,7 +724,7 @@ public:
/**
* Implements the product of two functions.
* The functor class with type \c "product" returns @f$ f(x) = f_1(x) f_2(x) @f$.
* The functor class with type @c "product" returns @f$ f(x) = f_1(x) f_2(x) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param f2 Functor @f$ f_2(x) @f$
* @ingroup func1compound
@ -794,7 +794,7 @@ public:
/**
* Implements the product of a function and a constant.
* The functor class with type \c "times-constant" returns @f$ f(x) = a f_1(x) @f$.
* The functor class with type @c "times-constant" returns @f$ f(x) = a f_1(x) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param a Constant @f$ a @f$
* @ingroup func1modified
@ -874,7 +874,7 @@ public:
/**
* Implements the sum of a function and a constant.
* The functor class with type \c "plus-constant" returns @f$ f(x) = f_1(x) + a @f$.
* The functor class with type @c "plus-constant" returns @f$ f(x) = f_1(x) + a @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param a Constant @f$ a @f$
* @ingroup func1modified
@ -940,7 +940,7 @@ public:
/**
* Implements the ratio of two functions.
* The functor class with type \c "ratio" returns @f$ f(x) = f_1(x) / f_2(x) @f$.
* The functor class with type @c "ratio" returns @f$ f(x) = f_1(x) / f_2(x) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param f2 Functor @f$ f_2(x) @f$
* @ingroup func1compound
@ -1009,7 +1009,7 @@ public:
/**
* Implements a composite function.
* The functor class with type \c "composite" returns @f$ f(x) = f_1\left(f_2(x)\right) @f$.
* The functor class with type @c "composite" returns @f$ f(x) = f_1\left(f_2(x)\right) @f$.
* @param f1 Functor @f$ f_1(x) @f$
* @param f2 Functor @f$ f_2(x) @f$
* @ingroup func1compound
@ -1081,7 +1081,7 @@ public:
/**
* Implements a Gaussian function.
* The functor class with type \c "Gaussian" returns
* The functor class with type @c "Gaussian" returns
* @f[
* f(t) = A e^{-[(t - t_0)/\tau]^2}
* @f]
@ -1159,8 +1159,8 @@ class Gaussian : public Gaussian1
/**
* Implements a polynomial of degree \e n.
* The functor class with type \c "polynomial" returns
* Implements a polynomial of degree @e n.
* The functor class with type @c "polynomial" returns
* @f[
* f(x) = a_n x^n + \dots + a_1 x + a_0
* @f]
@ -1215,7 +1215,7 @@ protected:
/**
* Implements a Fourier cosine/sine series.
* The functor class with type \c "Fourier" returns
* The functor class with type @c "Fourier" returns
* @f[
* f(t) = \frac{A_0}{2} +
* \sum_{n=1}^N A_n \cos (n \omega t) + B_n \sin (n \omega t)
@ -1281,7 +1281,7 @@ protected:
/**
* Implements a sum of Arrhenius terms.
* The functor class with type \c "Arrhenius" returns
* The functor class with type @c "Arrhenius" returns
* @f[
* f(T) = \sum_{n=1}^N A_n T^b_n \exp(-E_n/T)
* @f]

2
include/cantera/numerics/Integrator.h
View File

@ -333,7 +333,7 @@ private:
// defined in Integrators.cpp
//! Create new Integrator object
//! @param itype Integration mode; either \c CVODE or \c IDA
//! @param itype Integration mode; either @c CVODE or @c IDA
//! @ingroup odeGroup
Integrator* newIntegrator(const string& itype);

4
include/cantera/oneD/Domain1D.h
View File

@ -207,7 +207,7 @@ public:
m_name[n] = name;
}
//! index of component with name \a name.
//! index of component with name @e name.
virtual size_t componentIndex(const string& name) const;
void setBounds(size_t n, double lower, double upper) {
@ -536,7 +536,7 @@ public:
*/
virtual void _getInitialSoln(double* x);
//! Initial value of solution component \a n at grid point \a j.
//! Initial value of solution component @e n at grid point @e j.
virtual double initialValue(size_t n, size_t j);
/**

4
include/cantera/oneD/StFlow.h
View File

@ -216,8 +216,8 @@ public:
virtual size_t getSolvingStage() const;
//! Solving stage mode for handling ionized species (used by IonFlow specialization)
//! - \c stage=1: the fluxes of charged species are set to zero
//! - \c stage=2: the electric field equation is solved, and the drift flux for
//! - @c stage=1: the fluxes of charged species are set to zero
//! - @c stage=2: the electric field equation is solved, and the drift flux for
//! ionized species is evaluated
virtual void setSolvingStage(const size_t stage);

4
include/cantera/thermo/MultiSpeciesThermo.h
View File

@ -99,7 +99,7 @@ public:
//! Minimum temperature.
/*!
* If no argument is supplied, this method returns the minimum temperature
* for which \e all parameterizations are valid. If an integer index k is
* for which @e all parameterizations are valid. If an integer index k is
* supplied, then the value returned is the minimum temperature for
* species k in the phase.
*
@ -110,7 +110,7 @@ public:
//! Maximum temperature.
/*!
* If no argument is supplied, this method returns the maximum temperature
* for which \e all parameterizations are valid. If an integer index k is
* for which @e all parameterizations are valid. If an integer index k is
* supplied, then the value returned is the maximum temperature for
* parameterization k.
*

14
include/cantera/thermo/Phase.h
View File

@ -218,7 +218,7 @@ public:
//! which take an array pointer.
void checkElementArraySize(size_t mm) const;
//! Number of atoms of element \c m in species \c k.
//! Number of atoms of element @c m in species @c k.
//! @param k species index
//! @param m element index
double nAtoms(size_t k, size_t m) const;
@ -357,7 +357,7 @@ public:
//! @{
//! Set the species mole fractions by name.
//! Species not listed by name in \c xMap are set to zero.
//! Species not listed by name in @c xMap are set to zero.
//! @param xMap map from species names to mole fraction values.
void setMoleFractionsByName(const Composition& xMap);
@ -367,12 +367,12 @@ public:
void setMoleFractionsByName(const string& x);
//! Set the species mass fractions by name.
//! Species not listed by name in \c yMap are set to zero.
//! Species not listed by name in @c yMap are set to zero.
//! @param yMap map from species names to mass fraction values.
void setMassFractionsByName(const Composition& yMap);
//! Set the species mass fractions by name.
//! Species not listed by name in \c x are set to zero.
//! Species not listed by name in @c x are set to zero.
//! @param x String containing a composition map
void setMassFractionsByName(const string& x);
@ -458,9 +458,9 @@ public:
//! @} end group set thermo state
//! Molecular weight of species \c k.
//! @param k index of species \c k
//! @returns the molecular weight of species \c k.
//! Molecular weight of species @c k.
//! @param k index of species @c k
//! @returns the molecular weight of species @c k.
double molecularWeight(size_t k) const;
//! Copy the vector of molecular weights into vector weights.

2
include/cantera/thermo/PlasmaPhase.h
View File

@ -80,7 +80,7 @@ public:
//! Set electron energy levels.
//! @param levels The vector of electron energy levels (eV).
//! Length: #m_nPoints.
//! @param length The length of the \p levels.
//! @param length The length of the @c levels.
void setElectronEnergyLevels(const double* levels, size_t length);
//! Get electron energy levels.

8
include/cantera/thermo/ThermoPhase.h
View File

@ -152,8 +152,8 @@ public:
//! or phase are valid.
/*!
* If no argument is supplied, the value returned will be the lowest
* temperature at which the data for \e all species are valid. Otherwise,
* the value will be only for species \a k. This function is a wrapper that
* temperature at which the data for @e all species are valid. Otherwise,
* the value will be only for species @e k. This function is a wrapper that
* calls the species thermo minTemp function.
*
* @param k index of the species. Default is -1, which will return the max
@ -205,8 +205,8 @@ public:
//! are valid.
/*!
* If no argument is supplied, the value returned will be the highest
* temperature at which the data for \e all species are valid. Otherwise,
* the value will be only for species \a k. This function is a wrapper that
* temperature at which the data for @e all species are valid. Otherwise,
* the value will be only for species @e k. This function is a wrapper that
* calls the species thermo maxTemp function.
*
* @param k index of the species. Default is -1, which will return the min

2
include/cantera/transport/GasTransport.h
View File

@ -33,7 +33,7 @@ public:
* \mu = \sum_k \frac{\mu_k X_k}{\sum_j \Phi_{k,j} X_j}.
* @f]
*
* Here @f$ \mu_k @f$ is the viscosity of pure species \e k, and
* Here @f$ \mu_k @f$ is the viscosity of pure species @e k, and
*
* @f[
* \Phi_{k,j} = \frac{\left[1

6
include/cantera/transport/MixTransport.h
View File

@ -27,7 +27,7 @@ namespace Cantera
* \mu = \sum_k \frac{\mu_k X_k}{\sum_j \Phi_{k,j} X_j}.
* @f]
*
* Here @f$ \mu_k @f$ is the viscosity of pure species \e k, and
* Here @f$ \mu_k @f$ is the viscosity of pure species @e k, and
*
* @f[
* \Phi_{k,j} = \frac{\left[1
@ -102,7 +102,7 @@ public:
* \mu^e_k = \frac{F D_k}{R T}
* @f]
*
* @param mobil Returns the mobilities of the species in array \c mobil.
* @param mobil Returns the mobilities of the species in array @c mobil.
* The array must be dimensioned at least as large as the
* number of species.
*/
@ -127,7 +127,7 @@ public:
/*!
* Units for the returned fluxes are kg m-2 s-1.
*
* The diffusive mass flux of species \e k is computed from
* The diffusive mass flux of species @e k is computed from
* @f[
* \vec{j}_k = -n M_k D_k \nabla X_k.
* @f]

4
include/cantera/transport/Transport.h
View File

@ -339,7 +339,7 @@ public:
* \mu^e_k = \frac{F D_k}{R T}
* @f]
*
* @param mobil_e Returns the mobilities of the species in array \c
* @param mobil_e Returns the mobilities of the species in array @c
* mobil_e. The array must be dimensioned at least as large as
* the number of species.
*/
@ -361,7 +361,7 @@ public:
* \mu^f_k = \frac{D_k}{R T}
* @f]
*
* @param mobil_f Returns the mobilities of the species in array \c mobil.
* @param mobil_f Returns the mobilities of the species in array @c mobil.
* The array must be dimensioned at least as large as the
* number of species.
*

10
samples/cxx/bvp/BoundaryValueProblem.h
View File

@ -106,7 +106,7 @@ public:
}
/**
* Set parameters and options for solution component \a n.
* Set parameters and options for solution component @e n.
* This method should be invoked for each solution component
* before calling 'solve'. The parameter values should first
* be set by creating an instance of class Component, and
@ -185,8 +185,8 @@ public:
}
/**
* Initial value of solution component \a n at initial grid
* point \a j. The default is zero for all components at all
* Initial value of solution component @e n at initial grid
* point @e j. The default is zero for all components at all
* grid points. Overload in derived classes to specify other
* choices for initial values.
*/
@ -263,7 +263,7 @@ protected:
}
/**
* First derivative of component \a n at point \a j. The derivative
* First derivative of component @e n at point @e j. The derivative
* is formed to the right of point j, using values at point j
* and point j + 1.
*/
@ -272,7 +272,7 @@ protected:
}
/**
* First derivative of component \a n at point \a j. The derivative
* First derivative of component @e n at point @e j. The derivative
* is formed to the left of point j, using values at point j
* and point j - 1.
*/