Skip to content

Improve documentation of 1D (flame) solver #25

@speth

Description

@speth

Abstract
Better documentation of the 1D (flame) solver is needed, in a couple of areas.

Proposed Solution
API Documentation: Many member variables and some member functions of classes used in 1D flame simulations are not documented, or are not documented in a way that Doxygen can include them in the generated API documentation. Notably affected classes:

  • StFlow
  • OneDim
  • Bdry1D
  • Inlet1D
  • ReactingSurf1D

As an implementation note, one case where documentation should not be added are overrides for which the base class's documentation is adequate. Doxygen pages for derived classes automatically shows the base class documentation for such methods.

Solution Method Documentation: While the governing equations are reasonably-well documented on the website, the method of solving these equations is not. The main components are:

  • Discretization of the governing equations
  • Handling of boundary conditions
  • Handling of algebraic constraints
  • Grid refinement algorithm
  • Hybrid time stepping / steady state solver

This documentation should be added to the "Science" section of the website.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeature-requestNew feature requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions