Cantera  3.0.0
Loading...
Searching...
No Matches
Boundary1D Class Reference

The base class for boundaries between one-dimensional spatial domains. More...

#include <Boundary1D.h>

Inheritance diagram for Boundary1D:
[legend]

Detailed Description

The base class for boundaries between one-dimensional spatial domains.

The boundary may have its own internal variables, such as surface species coverages.

The boundary types are an inlet, an outlet, a symmetry plane, and a surface.

The public methods are all virtual, and the base class implementations throw exceptions.

Definition at line 39 of file Boundary1D.h.

Public Member Functions

void init () override
 Initialize.
 
string type () const override
 String indicating the domain implemented.
 
bool isConnector () override
 True if the domain is a connector domain.
 
virtual void setTemperature (double t)
 Set the temperature.
 
virtual double temperature ()
 Temperature [K].
 
virtual size_t nSpecies ()
 
virtual void setMoleFractions (const string &xin)
 Set the mole fractions by specifying a string.
 
virtual void setMoleFractions (const double *xin)
 Set the mole fractions by specifying an array.
 
virtual double massFraction (size_t k)
 Mass fraction of species k.
 
virtual void setMdot (double mdot)
 Set the total mass flow rate.
 
virtual void setSpreadRate (double V0)
 Set tangential velocity gradient [1/s] at this boundary.
 
virtual double spreadRate ()
 Tangential velocity gradient [1/s] at this boundary.
 
virtual double mdot ()
 The total mass flow rate [kg/m2/s].
 
void setupGrid (size_t n, const double *z) override
 called to set up initial grid, and after grid refinement
 
void fromArray (SolutionArray &arr, double *soln) override
 Restore the solution for this domain from a SolutionArray.
 
- Public Member Functions inherited from Domain1D
 Domain1D (size_t nv=1, size_t points=1, double time=0.0)
 Constructor.
 
 Domain1D (const Domain1D &)=delete
 
Domain1Doperator= (const Domain1D &)=delete
 
int domainType ()
 Domain type flag.
 
virtual string type () const
 String indicating the domain implemented.
 
size_t domainIndex ()
 The left-to-right location of this domain.
 
virtual bool isConnector ()
 True if the domain is a connector domain.
 
void setSolution (shared_ptr< Solution > sol)
 Set the solution manager.
 
virtual void setKinetics (shared_ptr< Kinetics > kin)
 Set the kinetics manager.
 
virtual void setTransport (shared_ptr< Transport > trans)
 Set transport model to existing instance.
 
const OneDimcontainer () const
 The container holding this domain.
 
void setContainer (OneDim *c, size_t index)
 Specify the container object for this domain, and the position of this domain in the list.
 
void setBandwidth (int bw=-1)
 Set the Jacobian bandwidth. See the discussion of method bandwidth().
 
size_t bandwidth ()
 Set the Jacobian bandwidth for this domain.
 
virtual void init ()
 Initialize.
 
virtual void setInitialState (double *xlocal=0)
 
virtual void setState (size_t point, const double *state, double *x)
 
virtual void resetBadValues (double *xg)
 When called, this function should reset "bad" values in the state vector such as negative species concentrations.
 
virtual void resize (size_t nv, size_t np)
 Resize the domain to have nv components and np grid points.
 
Refinerrefiner ()
 Return a reference to the grid refiner.
 
size_t nComponents () const
 Number of components at each grid point.
 
void checkComponentIndex (size_t n) const
 Check that the specified component index is in range.
 
void checkComponentArraySize (size_t nn) const
 Check that an array size is at least nComponents().
 
size_t nPoints () const
 Number of grid points in this domain.
 
void checkPointIndex (size_t n) const
 Check that the specified point index is in range.
 
void checkPointArraySize (size_t nn) const
 Check that an array size is at least nPoints().
 
virtual string componentName (size_t n) const
 Name of the nth component. May be overloaded.
 
void setComponentName (size_t n, const string &name)
 
virtual size_t componentIndex (const string &name) const
 index of component with name name.
 
void setBounds (size_t n, double lower, double upper)
 
void setTransientTolerances (double rtol, double atol, size_t n=npos)
 Set tolerances for time-stepping mode.
 
void setSteadyTolerances (double rtol, double atol, size_t n=npos)
 Set tolerances for steady-state mode.
 
double rtol (size_t n)
 Relative tolerance of the nth component.
 
double atol (size_t n)
 Absolute tolerance of the nth component.
 
double steady_rtol (size_t n)
 Steady relative tolerance of the nth component.
 
double steady_atol (size_t n)
 Steady absolute tolerance of the nth component.
 
double transient_rtol (size_t n)
 Transient relative tolerance of the nth component.
 
double transient_atol (size_t n)
 Transient absolute tolerance of the nth component.
 
double upperBound (size_t n) const
 Upper bound on the nth component.
 
double lowerBound (size_t n) const
 Lower bound on the nth component.
 
void initTimeInteg (double dt, const double *x0)
 Prepare to do time stepping with time step dt.
 
void setSteadyMode ()
 Prepare to solve the steady-state problem.
 
bool steady ()
 True if in steady-state mode.
 
bool transient ()
 True if not in steady-state mode.
 
void needJacUpdate ()
 Set this if something has changed in the governing equations (for example, the value of a constant has been changed, so that the last-computed Jacobian is no longer valid.
 
virtual void eval (size_t j, double *x, double *r, integer *mask, double rdt=0.0)
 Evaluate the residual function at point j.
 
size_t index (size_t n, size_t j) const
 
double value (const double *x, size_t n, size_t j) const
 
virtual void setJac (MultiJac *jac)
 
AnyMap serialize (const double *soln) const
 Save the state of this domain as an AnyMap.
 
virtual shared_ptr< SolutionArrayasArray (const double *soln) const
 Save the state of this domain as a SolutionArray.
 
shared_ptr< SolutionArraytoArray (bool normalize=false) const
 Save the state of this domain to a SolutionArray.
 
void restore (const AnyMap &state, double *soln, int loglevel)
 Restore the solution for this domain from an AnyMap.
 
virtual void fromArray (SolutionArray &arr, double *soln)
 Restore the solution for this domain from a SolutionArray.
 
void fromArray (const shared_ptr< SolutionArray > &arr)
 Restore the solution for this domain from a SolutionArray.
 
shared_ptr< Solutionsolution () const
 Return thermo/kinetics/transport manager used in the domain.
 
size_t size () const
 
void locate ()
 Find the index of the first grid point in this domain, and the start of its variables in the global solution vector.
 
virtual size_t loc (size_t j=0) const
 Location of the start of the local solution vector in the global solution vector,.
 
size_t firstPoint () const
 The index of the first (that is, left-most) grid point belonging to this domain.
 
size_t lastPoint () const
 The index of the last (that is, right-most) grid point belonging to this domain.
 
void linkLeft (Domain1D *left)
 Set the left neighbor to domain 'left.
 
void linkRight (Domain1D *right)
 Set the right neighbor to domain 'right.'.
 
void append (Domain1D *right)
 Append domain 'right' to this one, and update all links.
 
Domain1Dleft () const
 Return a pointer to the left neighbor.
 
Domain1Dright () const
 Return a pointer to the right neighbor.
 
double prevSoln (size_t n, size_t j) const
 Value of component n at point j in the previous solution.
 
void setID (const string &s)
 Specify an identifying tag for this domain.
 
string id () const
 
virtual void showSolution_s (std::ostream &s, const double *x)
 
virtual void showSolution (const double *x)
 Print the solution.
 
virtual void show (std::ostream &s, const double *x)
 Print the solution.
 
virtual void show (const double *x)
 Print the solution.
 
double z (size_t jlocal) const
 
double zmin () const
 
double zmax () const
 
void setProfile (const string &name, double *values, double *soln)
 
vector< double > & grid ()
 
const vector< double > & grid () const
 
double grid (size_t point) const
 
virtual void setupGrid (size_t n, const double *z)
 called to set up initial grid, and after grid refinement
 
virtual void _getInitialSoln (double *x)
 Writes some or all initial solution values into the global solution array, beginning at the location pointed to by x.
 
virtual double initialValue (size_t n, size_t j)
 Initial value of solution component n at grid point j.
 
virtual void _finalize (const double *x)
 In some cases, a domain may need to set parameters that depend on the initial solution estimate.
 
void forceFullUpdate (bool update)
 In some cases, for computational efficiency some properties (such as transport coefficients) may not be updated during Jacobian evaluations.
 
void setData (shared_ptr< vector< double > > &data)
 Set shared data pointer.
 

Protected Member Functions

void _init (size_t n)
 
- Protected Member Functions inherited from Domain1D
virtual AnyMap getMeta () const
 Retrieve meta data.
 
virtual void setMeta (const AnyMap &meta)
 Retrieve meta data.
 

Protected Attributes

StFlowm_flow_left = nullptr
 
StFlowm_flow_right = nullptr
 
size_t m_ilr = 0
 
size_t m_left_nv = 0
 
size_t m_right_nv = 0
 
size_t m_left_loc = 0
 
size_t m_right_loc = 0
 
size_t m_left_points = 0
 
size_t m_left_nsp = 0
 
size_t m_right_nsp = 0
 
size_t m_sp_left = 0
 
size_t m_sp_right = 0
 
size_t m_start_left = 0
 
size_t m_start_right = 0
 
ThermoPhasem_phase_left = nullptr
 
ThermoPhasem_phase_right = nullptr
 
double m_temp = 0.0
 
double m_mdot = 0.0
 
- Protected Attributes inherited from Domain1D
shared_ptr< vector< double > > m_state
 data pointer shared from OneDim
 
double m_rdt = 0.0
 
size_t m_nv = 0
 
size_t m_points
 Number of grid points.
 
vector< double > m_slast
 
vector< double > m_max
 
vector< double > m_min
 
vector< double > m_rtol_ss
 
vector< double > m_rtol_ts
 
vector< double > m_atol_ss
 
vector< double > m_atol_ts
 
vector< double > m_z
 
OneDimm_container = nullptr
 
size_t m_index
 
int m_type = 0
 
size_t m_iloc = 0
 Starting location within the solution vector for unknowns that correspond to this domain.
 
size_t m_jstart = 0
 
Domain1Dm_left = nullptr
 
Domain1Dm_right = nullptr
 
string m_id
 Identity tag for the domain.
 
unique_ptr< Refinerm_refiner
 
vector< string > m_name
 
int m_bw = -1
 
bool m_force_full_update = false
 
shared_ptr< Solutionm_solution
 Composite thermo/kinetics/transport handler.
 

Constructor & Destructor Documentation

◆ Boundary1D()

Definition at line 16 of file Boundary1D.cpp.

Member Function Documentation

◆ init()

void init ( )
inlineoverridevirtual

Initialize.

This method is called by OneDim::init() for each domain once at the beginning of a simulation. Base class method does nothing, but may be overloaded.

Reimplemented from Domain1D.

Reimplemented in Inlet1D, Empty1D, Symm1D, Outlet1D, OutletRes1D, Surf1D, and ReactingSurf1D.

Definition at line 44 of file Boundary1D.h.

◆ type()

string type ( ) const
inlineoverridevirtual

String indicating the domain implemented.

Since
New in Cantera 3.0.
Todo:
Transition back to domainType after Cantera 3.0

Reimplemented from Domain1D.

Reimplemented in Inlet1D, Empty1D, Symm1D, Outlet1D, OutletRes1D, Surf1D, and ReactingSurf1D.

Definition at line 48 of file Boundary1D.h.

◆ isConnector()

bool isConnector ( )
inlineoverridevirtual

True if the domain is a connector domain.

Reimplemented from Domain1D.

Definition at line 52 of file Boundary1D.h.

◆ setTemperature()

virtual void setTemperature ( double  t)
inlinevirtual

Set the temperature.

Definition at line 57 of file Boundary1D.h.

◆ temperature()

virtual double temperature ( )
inlinevirtual

Temperature [K].

Definition at line 62 of file Boundary1D.h.

◆ nSpecies()

virtual size_t nSpecies ( )
inlinevirtual

Definition at line 66 of file Boundary1D.h.

◆ setMoleFractions() [1/2]

virtual void setMoleFractions ( const string &  xin)
inlinevirtual

Set the mole fractions by specifying a string.

Reimplemented in Inlet1D, and OutletRes1D.

Definition at line 71 of file Boundary1D.h.

◆ setMoleFractions() [2/2]

virtual void setMoleFractions ( const double *  xin)
inlinevirtual

Set the mole fractions by specifying an array.

Reimplemented in Inlet1D, and OutletRes1D.

Definition at line 76 of file Boundary1D.h.

◆ massFraction()

virtual double massFraction ( size_t  k)
inlinevirtual

Mass fraction of species k.

Reimplemented in Inlet1D, and OutletRes1D.

Definition at line 81 of file Boundary1D.h.

◆ setMdot()

virtual void setMdot ( double  mdot)
inlinevirtual

Set the total mass flow rate.

Definition at line 86 of file Boundary1D.h.

◆ setSpreadRate()

virtual void setSpreadRate ( double  V0)
inlinevirtual

Set tangential velocity gradient [1/s] at this boundary.

Reimplemented in Inlet1D.

Definition at line 91 of file Boundary1D.h.

◆ spreadRate()

virtual double spreadRate ( )
inlinevirtual

Tangential velocity gradient [1/s] at this boundary.

Reimplemented in Inlet1D.

Definition at line 96 of file Boundary1D.h.

◆ mdot()

virtual double mdot ( )
inlinevirtual

The total mass flow rate [kg/m2/s].

Definition at line 101 of file Boundary1D.h.

◆ setupGrid()

void setupGrid ( size_t  n,
const double *  z 
)
inlineoverridevirtual

called to set up initial grid, and after grid refinement

Reimplemented from Domain1D.

Definition at line 105 of file Boundary1D.h.

◆ fromArray()

void fromArray ( SolutionArray arr,
double *  soln 
)
overridevirtual

Restore the solution for this domain from a SolutionArray.

Parameters
[in]arrSolutionArray defining the state of this domain
[out]solnValue of the solution vector, local to this domain
Since
New in Cantera 3.0.

Reimplemented from Domain1D.

Reimplemented in Inlet1D, OutletRes1D, Surf1D, and ReactingSurf1D.

Definition at line 80 of file Boundary1D.cpp.

◆ _init()

void _init ( size_t  n)
protected

Definition at line 21 of file Boundary1D.cpp.

Member Data Documentation

◆ m_flow_left

StFlow* m_flow_left = nullptr
protected

Definition at line 112 of file Boundary1D.h.

◆ m_flow_right

StFlow* m_flow_right = nullptr
protected

Definition at line 113 of file Boundary1D.h.

◆ m_ilr

size_t m_ilr = 0
protected

Definition at line 114 of file Boundary1D.h.

◆ m_left_nv

size_t m_left_nv = 0
protected

Definition at line 115 of file Boundary1D.h.

◆ m_right_nv

size_t m_right_nv = 0
protected

Definition at line 116 of file Boundary1D.h.

◆ m_left_loc

size_t m_left_loc = 0
protected

Definition at line 117 of file Boundary1D.h.

◆ m_right_loc

size_t m_right_loc = 0
protected

Definition at line 118 of file Boundary1D.h.

◆ m_left_points

size_t m_left_points = 0
protected

Definition at line 119 of file Boundary1D.h.

◆ m_left_nsp

size_t m_left_nsp = 0
protected

Definition at line 120 of file Boundary1D.h.

◆ m_right_nsp

size_t m_right_nsp = 0
protected

Definition at line 121 of file Boundary1D.h.

◆ m_sp_left

size_t m_sp_left = 0
protected

Definition at line 122 of file Boundary1D.h.

◆ m_sp_right

size_t m_sp_right = 0
protected

Definition at line 123 of file Boundary1D.h.

◆ m_start_left

size_t m_start_left = 0
protected

Definition at line 124 of file Boundary1D.h.

◆ m_start_right

size_t m_start_right = 0
protected

Definition at line 125 of file Boundary1D.h.

◆ m_phase_left

ThermoPhase* m_phase_left = nullptr
protected

Definition at line 126 of file Boundary1D.h.

◆ m_phase_right

ThermoPhase* m_phase_right = nullptr
protected

Definition at line 127 of file Boundary1D.h.

◆ m_temp

double m_temp = 0.0
protected

Definition at line 128 of file Boundary1D.h.

◆ m_mdot

double m_mdot = 0.0
protected

Definition at line 129 of file Boundary1D.h.


The documentation for this class was generated from the following files: