research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doxygen update

Browse source
This commit is contained in:
Harry Moffat 2008-01-28 23:59:19 +00:00
parent 1f9e3cb24a
commit f97722ed22
2 changed files with 176 additions and 148 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

322
Cantera/src/equil/vcs_defs.h
View file

@ -17,14 +17,10 @@
namespace VCSnonideal {
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
*
* COMMON DEFINITIONS -> Protect them against redefinitions
*/
/*
* COMMON DEFINITIONS -> Protect them against redefinitions
*/
//@{
#ifndef TRUE
# define TRUE 1
#endif
@ -33,10 +29,6 @@ namespace VCSnonideal {
# define FALSE 0
#endif
#ifndef BOOLEAN
# define BOOLEAN int
#endif
#ifndef MAX
# define MAX(x,y) (( (x) > (y) ) ? (x) : (y))
#endif
@ -57,14 +49,13 @@ namespace VCSnonideal {
# define DSIGN(x) (( (x) == (0.0) ) ? (0.0) : ( ((x) > 0.0) ? 1.0 : -1.0 ))
#endif
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* ERROR CODES
*
*/
//@}
/*!
* ERROR CODES
*
*/
//@{
#define VCS_SUCCESS 0
#define VCS_NOMEMORY 1
#define VCS_FAILED_CONVERGENCE -1
@ -73,180 +64,217 @@ namespace VCSnonideal {
#define VCS_THERMO_OUTOFRANGE -4
#define VCS_FAILED_LOOKUP -5
#define VCS_MP_FAIL -6
//@}
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* Maximum Length of any name in this package
*/
#define VCS_MAX_NAME_LEN 31
#define VCS_MAX_NAME_LEN_P1 32
/*!
* @name Type of the underlying equilibrium solve
*
* @{
*/
//! Current, it is always done holding T and P constant.
#define VCS_PROBTYPE_TP 0
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* SIZES OF PHASES AND MOLE NUMBER CUTOFFS
*
* VCS_DELETE_SPECIES_CUTOFF: Cutoff relative mole number value,
* below which species are deleted
* from the equilibrium problem.
*/
//@}
/*!
* @name Sizes of Phases and Cutoff Mole Numbers
*
* @{
*/
//! Cutoff relative mole number value,
//! below which species are deleted from the equilibrium problem.
#ifndef VCS_DELETE_SPECIES_CUTOFF
#define VCS_DELETE_SPECIES_CUTOFF 1.0e-32
#endif
//! Cutoff relative mole number value,
//! below which species are deleted from the equilibrium problem.
#ifndef VCS_DELETE_MINORSPECIES_CUTOFF
#define VCS_DELETE_MINORSPECIES_CUTOFF 1.0e-140
#endif
/*
* VCS_SMALL_MULTIPHASE_SPECIES:
* Relative value of multiphase
* species mole number for a multiphase
* species which is small.
*/
//! Relative value of multiphase species mole number for a
//! multiphase species which is small.
#ifndef VCS_SMALL_MULTIPHASE_SPECIES
#define VCS_SMALL_MULTIPHASE_SPECIES 1.0e-25
#endif
/*
* VCS_DELETE_PHASE_CUTOFF: Cutoff relative moles below
* which a phase is deleted
* from the equilibrium problem.
*/
//! Cutoff relative moles below which a phase is deleted
//! from the equilibrium problem.
#ifndef VCS_DELETE_PHASE_CUTOFF
#define VCS_DELETE_PHASE_CUTOFF 1.0e-11
#endif
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* State of Dimensional Units for Gibbs free energies
*/
//@}
/*!
* @name State of Dimensional Units for Gibbs free energies
*
* @{
*/
//! nondimensional
#define VCS_NONDIMENSIONAL_G 1
//! dimensioned
#define VCS_DIMENSIONAL_G 0
//@}
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* SPECIES CATEGORIES USED IN VCS_SOLVE_TP
*/
//! @name Species Types during the iteration
//! valid values for spStatus()
//@{
//! Species is a component
//! @name Species Categories used during the iteration
/*!
* These defines are valid values for spStatus()
*/
//@{
//! Species is a component
#define VCS_SPECIES_COMPONENT 2
//! Species is a major species
/*!
* A major species is either a species in a multicomponent phase with
* significant concentration or its a Stoich Phase
*/
//! Species is a major species
/*!
* A major species is either a species in a multicomponent phase with
* significant concentration or its a Stoich Phase
*/
#define VCS_SPECIES_MAJOR 1
//! Species is a major species
/*!
* A major species is either a species in a multicomponent phase with
* significant concentration or its a Stoich Phase
*/
//! Species is a major species
/*!
* A major species is either a species in a multicomponent phase with
* significant concentration or its a Stoich Phase
*/
#define VCS_SPECIES_MINOR 0
//! Species lies in a multicomponent phase that is zeroed atm
/*!
* The species lies in a multicomponent phase that is currently
* deleted.
*/
//! Species lies in a multicomponent phase that is zeroed atm
/*!
* The species lies in a multicomponent phase that is currently
* deleted.
*/
#define VCS_SPECIES_ZEROEDPHASE -1
//! Species lies in a multicomponent phase, with concentration zero
/*!
* The species lies in a multicomponent phase that exists.
* It concentration is currently zero, even though it may
* or may not actually have a low mole fraction in the phase
* this situation occurs when phases pop back into life.
*/
//! Species lies in a multicomponent phase, with concentration zero
/*!
* The species lies in a multicomponent phase that exists.
* It concentration is currently zero, even though it may
* or may not actually have a low mole fraction in the phase
* this situation occurs when phases pop back into life.
*/
#define VCS_SPECIES_ZEROEDMS -2
//! Species is a SS phase, that is currently zeroed out.
/*!
* The species lies in a single-species phase which
* is currently zereod out.
*/
//! Species is a SS phase, that is currently zeroed out.
/*!
* The species lies in a single-species phase which
* is currently zereod out.
*/
#define VCS_SPECIES_ZEROEDSS -3
//! Species has such a small mole fraction it is deleted.
/*!
* The species is believed to have such a small mole fraction
* that it best to throw the calculation of it out.
* It will be aded back in at the end of the calculation.
*/
//! Species has such a small mole fraction it is deleted.
/*!
* The species is believed to have such a small mole fraction
* that it best to throw the calculation of it out.
* It will be aded back in at the end of the calculation.
*/
#define VCS_SPECIES_DELETED -4
//! Species refers to an electron in the metal
/*!
* The unknown is equal to the interfacial voltage
* drop across the interface on the SHE (standard
* hyrdogen electrode) scale (volts).
*/
//! Species refers to an electron in the metal
/*!
* The unknown is equal to the interfacial voltage
* drop across the interface on the SHE (standard
* hyrdogen electrode) scale (volts).
*/
#define VCS_SPECIES_INTERFACIALVOLTAGE -5
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* Units for the chemical potential data and pressure variables:
*
* Chem_Pot Pres vol moles
* -------------------------------------------------
* VCS_UNITS_KCALMOL = kcal/mol atm cm**3 gmol
* VCS_UNITS_UNITLESS = MU / RT -> no units atm cm**3 gmol
* VCS_UNITS_KJMOL = kJ / mol atm cm**3 gmol
* VCS_UNITS_KELVIN = KELVIN -> MU / R atm cm**3 gmol
* VCS_UNITS_MKS = Joules / Kmol (Cantera) Pa m**3 kmol
*
* Energy:
* VCS_UNITS_KCALMOL = kcal/mol
* VCS_UNITS_UNITLESS = MU / RT -> no units
* VCS_UNITS_KJMOL = kJ / mol
* VCS_UNITS_KELVIN = KELVIN -> MU / R
* VCS_UNITS_MKS = J / kmol
*
* Pressure: (Pref and Pres)
* VCS_UNITS_KCALMOL = atm
* VCS_UNITS_UNITLESS = no units
* VCS_UNITS_KJMOL = atm
* VCS_UNITS_KELVIN = atm
* VCS_UNITS_MKS = Pa = kg / m s2
*/
//@}
/*!
* @name Units for the chemical potential data and pressure variables
*
* @verbatim
Chem_Pot Pres vol moles
-------------------------------------------------
VCS_UNITS_KCALMOL = kcal/mol atm cm**3 gmol
VCS_UNITS_UNITLESS = MU / RT -> no units atm cm**3 gmol
VCS_UNITS_KJMOL = kJ / mol atm cm**3 gmol
VCS_UNITS_KELVIN = KELVIN -> MU / R atm cm**3 gmol
VCS_UNITS_MKS = Joules / Kmol (Cantera) Pa m**3 kmol
Energy:
VCS_UNITS_KCALMOL = kcal/mol
VCS_UNITS_UNITLESS = MU / RT -> no units
VCS_UNITS_KJMOL = kJ / mol
VCS_UNITS_KELVIN = KELVIN -> MU / R
VCS_UNITS_MKS = J / kmol
Pressure: (Pref and Pres)
VCS_UNITS_KCALMOL = atm
VCS_UNITS_UNITLESS = no units
VCS_UNITS_KJMOL = atm
VCS_UNITS_KELVIN = atm
VCS_UNITS_MKS = Pa = kg / m s2
@endverbatim
* @{
*/
#define VCS_UNITS_KCALMOL -1
#define VCS_UNITS_UNITLESS 0
#define VCS_UNITS_KJMOL 1
#define VCS_UNITS_KELVIN 2
#define VCS_UNITS_MKS 3
//@}
/*!
* @name Types of Element Constraint Equations
*
* There may be several different types of element constraints handled
* by the equilibrium program. These defines are used to assign each
* constraint to one category.
* @{
*/
//! Normal element constraint consisting of positive coefficients for the
//! formula matrix.
/*!
* All species have positive coefficients within the formula matrix.
* With this constraint, we may employ various strategies to handle
* small values of the element number successfully.
*/
#define VCS_ELEM_TYPE_ABSPOS 0
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* Element type Defines
*/
#define VCS_ELEM_TYPE_ABSPOS 0
#define VCS_ELEM_TYPE_ELECTRONCHARGE 1
//! This refers to conservation of electrons
/*!
* Electrons may have positive or negative values in the Formula matrix.
*/
#define VCS_ELEM_TYPE_ELECTRONCHARGE 1
//! This refers to a charge neutrality of a single phase
/*!
* Charge neutrality may have positive or negative values in the Formula matrix.
*/
#define VCS_ELEM_TYPE_CHARGENEUTRALITY 2
//! Other constraint equations
/*!
* currently there are none
*/
#define VCS_ELEM_TYPE_OTHERCONSTRAINT 3
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
/*
* Species type Defines
*/
//@}
/*!
* @name Types of Species Unknowns in the problem
*
* @{
*/
//! Unknown refers to mole number of a single species
#define VCS_SPECIES_TYPE_MOLNUM 0
//! Unknown refers to the voltage level of a phase
/*!
* Typically, these species are electrons in metals. There is an
* infinite supply of them. However, their electrical potential
* is ddefined by the interface voltage.
*/
#define VCS_SPECIES_TYPE_INTERFACIALVOLTAGE -5
/****************************************************************************/
//@}
}
#endif

2
tools/doc/Cantera.cfg.in
View file

@ -133,7 +133,7 @@ FILE_PATTERNS = Kinetics.h Kinetics.cpp \
equil.h MultiPhase.h MultiPhase.cpp BasisOptimize.cpp \
Nasa9Poly1.h Nasa9Poly1.cpp \
Nasa9PolyMultiTempRegion.h Nasa9PolyMultiTempRegion.cpp \
vcs_internal.h \
vcs_internal.h vcs_defs.h \
vcs_MultiPhaseEquil.h vcs_MultiPhaseEquil.cpp
RECURSIVE = NO
EXCLUDE = CVS examples converters zeroD