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

[Doc] Update docs related to StFlow restructuring

Browse source
This commit is contained in:
Ray Speth 2018-08-10 10:47:05 -04:00
parent ac8612f36b
commit a54ab2f3ef
3 changed files with 38 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/sphinx/cython/onedim.rst
View file

@ -62,12 +62,10 @@ IonFlow
FreeFlow
^^^^^^^^
.. autoclass:: FreeFlow(thermo)
:inherited-members:
AxisymmetricStagnationFlow
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: AxisymmetricStagnationFlow(thermo)
:inherited-members:
Boundaries
----------

16
include/cantera/oneD/StFlow.h
View file

@ -147,16 +147,24 @@ public:
virtual void restore(const XML_Node& dom, doublereal* soln,
int loglevel);
//! Set flow configuration for freely-propagating flames, using an internal
//! point with a fixed temperature as the condition to determine the inlet
//! mass flux.
void setFreeFlow() {
m_type = cFreeFlow;
m_dovisc = false;
}
//! Set flow configuration for axisymmetric counterflow or burner-stabilized
//! flames, using specified inlet mass fluxes.
void setAxisymmetricFlow() {
m_type = cAxisymmetricStagnationFlow;
m_dovisc = true;
}
//! Return the type of flow domain being represented, either "Free Flame" or
//! "Axisymmetric Stagnation".
//! @see setFreeFlow setAxisymmetricFlow
virtual std::string flowType() {
if (m_type == cFreeFlow) {
return "Free Flame";
@ -460,6 +468,10 @@ private:
/**
* A class for axisymmetric stagnation flows.
*
* @deprecated To be removed after Cantera 2.4. Use class StFlow with the
* StFlow::setAxisymmetricFlow() method instead.
*
* @ingroup onedim
*/
class AxiStagnFlow : public StFlow
@ -476,6 +488,10 @@ public:
/**
* A class for freely-propagating premixed flames.
*
* @deprecated To be removed after Cantera 2.4. Use class StFlow with the
* StFlow::setFreeFlow() method instead.
*
* @ingroup onedim
*/
class FreeFlame : public StFlow

27
interfaces/cython/cantera/onedim.pyx
View file

@ -469,11 +469,18 @@ cdef class _FlowBase(Domain1D):
self.flow.enableRadiation(<cbool>do_radiation)
def set_free_flow(self):
""" Set flow type to free flow."""
"""
Set flow configuration for freely-propagating flames, using an internal
point with a fixed temperature as the condition to determine the inlet
mass flux.
"""
self.flow.setFreeFlow()
def set_axisymmetric_flow(self):
""" Set flow type to axisymmetric stagnation flow."""
"""
Set flow configuration for axisymmetric counterflow or burner-stabilized
flames, using specified inlet mass fluxes.
"""
self.flow.setAxisymmetricFlow()
@ -485,8 +492,8 @@ cdef CxxIdealGasPhase* getIdealGasPhase(ThermoPhase phase) except *:
cdef class IdealGasFlow(_FlowBase):
"""
An ideal gas flow domain. Functions set_free_flow and set_axisymmetric_flow
can be used to set different type of flow.
An ideal gas flow domain. Functions `set_free_flow` and
`set_axisymmetric_flow` can be used to set different type of flow.
For the type of axisymmetric flow, the equations solved are the similarity
equations for the flow in a finite-height gap of infinite radial extent.
@ -519,15 +526,25 @@ cdef class IdealGasFlow(_FlowBase):
cdef class FreeFlow(IdealGasFlow):
"""
.. deprecated:: 2.4
To be removed after Cantera 2.4. Use class `IdealGasFlow` instead and
call the ``set_free_flow()`` method.
"""
def __init__(self, *args, **kwargs):
warnings.warn("Class FreeFlow is deprecated and will be removed after"
" Cantera 2.4. Use class IdealGasFlow instead and call the"
" set_free_flow() method.")
" ``set_free_flow()`` method.")
super().__init__(*args, **kwargs)
self.set_free_flow()
cdef class AxisymmetricStagnationFlow(IdealGasFlow):
"""
.. deprecated:: 2.4
To be removed after Cantera 2.4. Use class `IdealGasFlow` instead and
call the ``set_axisymmetric_flow()`` method.
"""
def __init__(self, *args, **kwargs):
warnings.warn("Class AxisymmetricStagnationFlow is deprecated and will"
" be removed after Cantera 2.4. Use class IdealGasFlow instead and"