[Doc] Create a group for classes in the "onedim" module

This commit is contained in:
Ray Speth 2013-06-19 22:08:50 +00:00
parent 0945a6de9b
commit d21a6a7be9
9 changed files with 25 additions and 0 deletions

View file

@ -32,6 +32,7 @@ class OneDim;
/**
* Base class for one-dimensional domains.
* @ingroup onedim
*/
class Domain1D
{

View file

@ -36,6 +36,7 @@ const int RightInlet = -1;
*
* The public methods are all virtual, and the base class
* implementations throw exceptions.
* @ingroup onedim
*/
class Bdry1D : public Domain1D
{
@ -115,6 +116,7 @@ private:
/**
* An inlet.
* @ingroup onedim
*/
class Inlet1D : public Bdry1D
{
@ -188,6 +190,7 @@ protected:
/**
* A terminator that does nothing.
* @ingroup onedim
*/
class Empty1D : public Domain1D
{
@ -215,6 +218,7 @@ public:
/**
* A symmetry plane. The axial velocity u = 0, and all other
* components have zero axial gradients.
* @ingroup onedim
*/
class Symm1D : public Bdry1D
{
@ -272,6 +276,7 @@ public:
/**
* An outlet with specified composition.
* @ingroup onedim
*/
class OutletRes1D : public Bdry1D
{
@ -360,6 +365,7 @@ public:
/**
* A reacting surface.
* @ingroup onedim
*/
class ReactingSurf1D : public Bdry1D
{

View file

@ -21,6 +21,7 @@ namespace Cantera
* defined by a residual function supplied by an instance of class
* OneDim. The residual function may consist of several linked
* 1D domains, with different variables in each domain.
* @ingroup onedim
*/
class MultiJac : public BandMatrix
{

View file

@ -17,6 +17,7 @@ namespace Cantera
/**
* Newton iterator for multi-domain, one-dimensional problems.
* Used by class OneDim.
* @ingroup onedim
*/
class MultiNewton
{

View file

@ -17,6 +17,7 @@ class Func1;
/**
* Container class for multiple-domain 1D problems. Each domain is
* represented by an instance of Domain1D.
* @ingroup onedim
*/
class OneDim
{

View file

@ -14,6 +14,7 @@ namespace Cantera
/**
* One-dimensional simulations. Class Sim1D extends class OneDim by storing
* the solution vector, and by adding a hybrid Newton/time-stepping solver.
* @ingroup onedim
*/
class Sim1D : public OneDim
{

View file

@ -36,6 +36,7 @@ const int c_Soret = 2;
/**
* This class represents 1D flow domains that satisfy the one-dimensional
* similarity solution for chemically-reacting, axisymmetric, flows.
* @ingroup onedim
*/
class StFlow : public Domain1D
{
@ -501,6 +502,7 @@ private:
/**
* A class for axisymmetric stagnation flows.
* @ingroup onedim
*/
class AxiStagnFlow : public StFlow
{
@ -522,6 +524,7 @@ public:
/**
* A class for freely-propagating premixed flames.
* @ingroup onedim
*/
class FreeFlame : public StFlow
{

View file

@ -9,6 +9,7 @@ namespace Cantera
class Domain1D;
//! Refine Domain1D grids so that profiles satisfy adaptation tolerances
//! @ingroup onedim
class Refiner
{
public:

View file

@ -1,3 +1,13 @@
//! @file onedim.h
/*!
* @defgroup onedim One-Dimensional Reacting Flows
*
* These classes comprise Cantera's ability to solve steady-state one-
* dimensional reacting flow problems, such as laminar flames, opposed flow
* diffusion flames, and stagnation flow chemical vapor deposition.
*/
#ifndef CT_INCL_ONEDIM_H
#define CT_INCL_ONEDIM_H