Cantera  2.0
Domain1D Class Reference

Base class for one-dimensional domains. More...

#include <Domain1D.h>

Inheritance diagram for Domain1D:
[legend]
Collaboration diagram for Domain1D:
[legend]

## Public Member Functions

Domain1D (size_t nv=1, size_t points=1, doublereal time=0.0)
Constructor.

virtual ~Domain1D ()
Destructor. Does nothing.

int domainType ()
Domain type flag.

size_t domainIndex ()
The left-to-right location of this domain.

bool isConnector ()
True if the domain is a connector domain.

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)

size_t bandwidth ()
Set the Jacobian bandwidth for this domain.

virtual void init ()
Initialize.

virtual void setInitialState (doublereal *xlocal=0)

virtual void setState (size_t point, const doublereal *state, doublereal *x)

virtual void resize (size_t nv, size_t np)
Resize the domain to have nv components and np grid points.

Refiner & refiner ()
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 Throws an exception if n is greater than nComponents()-1.

void checkComponentArraySize (size_t nn) const
Check that an array size is at least nComponents() Throws an exception if nn is less than 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 Throws an exception if n is greater than nPoints()-1.

void checkPointArraySize (size_t nn) const
Check that an array size is at least nPoints() Throws an exception if nn is less than nPoints().

virtual std::string componentName (size_t n) const
Name of the nth component. May be overloaded.

void setComponentName (size_t n, std::string name)

void setComponentType (size_t n, int ctype)

size_t componentIndex (std::string name) const
index of component with name name.

void setBounds (size_t nl, const doublereal *lower, size_t nu, const doublereal *upper)
Set the lower and upper bounds for each solution component.

void setBounds (size_t n, doublereal lower, doublereal upper)

void setTolerances (size_t nr, const doublereal *rtol, size_t na, const doublereal *atol, int ts=0)
set the error tolerances for all solution components.

void setTolerances (size_t n, doublereal rtol, doublereal atol, int ts=0)
set the error tolerances for solution component n.

void setTolerances (doublereal rtol, doublereal atol, int ts=0)
set scalar error tolerances.

void setTolerancesTS (doublereal rtol, doublereal atol)

void setTolerancesSS (doublereal rtol, doublereal atol)

doublereal rtol (size_t n)
Relative tolerance of the nth component.

doublereal atol (size_t n)
Absolute tolerance of the nth component.

doublereal upperBound (size_t n) const
Upper bound on the nth component.

doublereal lowerBound (size_t n) const
Lower bound on the nth component.

void initTimeInteg (doublereal dt, const doublereal *x0)
Prepare to do time stepping with time step dt.

Prepare to solve the steady-state problem.

bool transient ()
True if not in steady-state mode.

void needJacUpdate ()
Set this if something has changed in the governing equations (e.g.

void evalss (doublereal *x, doublereal *r, integer *mask)
Evaluate the steady-state residual at all points, even if in transient mode.

virtual void eval (size_t j, doublereal *x, doublereal *r, integer *mask, doublereal rdt=0.0)
Evaluate the residual function at point j.

virtual doublereal residual (doublereal *x, size_t n, size_t j)

int timeDerivativeFlag (size_t n)

void setAlgebraic (size_t n)

virtual void update (doublereal *x)
Does nothing.

doublereal time () const

void incrementTime (doublereal dt)

size_t index (size_t n, size_t j) const

doublereal value (const doublereal *x, size_t n, size_t j) const

virtual void setJac (MultiJac *jac)

virtual void save (XML_Node &o, const doublereal *const sol)
Save the current solution for this domain into an XML_Node.

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 (i.e., left-most) grid point belonging to this domain.

size_t lastPoint () const
The index of the last (i.e., right-most) grid point belonging to this domain.

Set the left neighbor to domain 'left.

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 std::string &s)
Specify an identifying tag for this domain.

std::string id () const

void setDesc (const std::string &s)
Specify descriptive text for this domain.

const std::string & desc ()

virtual void showSolution_s (std::ostream &s, const doublereal *x)

virtual void showSolution (const doublereal *x)
Print the solution.

virtual void restore (const XML_Node &dom, doublereal *soln)

doublereal z (size_t jlocal) const

doublereal zmin () const

doublereal zmax () const

void setProfile (std::string name, doublereal *values, doublereal *soln)

vector_fpgrid ()

const vector_fpgrid () const

doublereal grid (size_t point)

virtual void setupGrid (size_t n, const doublereal *z)

void setGrid (size_t n, const doublereal *z)

virtual void _getInitialSoln (doublereal *x)
Writes some or all initial solution values into the global solution array, beginning at the location pointed to by x.

virtual doublereal initialValue (size_t n, size_t j)
Initial value of solution component n at grid point j.

virtual void _finalize (const doublereal *x)
In some cases, a domain may need to set parameters that depend on the initial solution estimate.

## Public Attributes

doublereal m_zfixed

doublereal m_tfixed

## Protected Attributes

doublereal m_rdt

size_t m_nv

size_t m_points

vector_fp m_slast

doublereal m_time

vector_fp m_max

vector_fp m_min

vector_fp m_rtol_ss

vector_fp m_rtol_ts

vector_fp m_atol_ss

vector_fp m_atol_ts

vector_fp m_z

OneDimm_container

size_t m_index

int m_type

size_t m_iloc
Starting location within the solution vector for unknowns that correspond to this domain.

size_t m_jstart

Domain1Dm_left

Domain1Dm_right

std::string m_id
Identity tag for the domain.

std::string m_desc

Refiner * m_refiner

vector_int m_td

std::vector< std::string > m_name

int m_bw

## Detailed Description

Base class for one-dimensional domains.

Definition at line 39 of file Domain1D.h.

## Constructor & Destructor Documentation

 Domain1D ( size_t nv = 1, size_t points = 1, doublereal time = 0.0 )
inline

Constructor.

Parameters
 nv Number of variables at each grid point. points Number of grid points.

Definition at line 48 of file Domain1D.h.

References Domain1D::resize().

 virtual ~Domain1D ( )
inlinevirtual

Destructor. Does nothing.

Definition at line 66 of file Domain1D.h.

## Member Function Documentation

 int domainType ( )
inline

Domain type flag.

Definition at line 71 of file Domain1D.h.

 size_t domainIndex ( )
inline

The left-to-right location of this domain.

Definition at line 78 of file Domain1D.h.

Referenced by Cantera::bound_step().

 bool isConnector ( )
inline

True if the domain is a connector domain.

Definition at line 85 of file Domain1D.h.

 const OneDim& container ( ) const
inline

The container holding this domain.

Definition at line 92 of file Domain1D.h.

 void setContainer ( OneDim * c, size_t index )
inline

Specify the container object for this domain, and the position of this domain in the list.

Definition at line 100 of file Domain1D.h.

 size_t bandwidth ( )
inline

Set the Jacobian bandwidth for this domain.

When class OneDim computes the bandwidth of the overall multi-domain problem (in OneDim::resize()), it calls this method for the bandwidth of each domain. If setBandwidth has not been called, then a negative bandwidth is returned, in which case OneDim assumes that this domain is dense – that is, at each point, all components depend on the value of all other components at that point. In this case, the bandwidth is bw = 2*nComponents() - 1. However, if this domain contains some components that are uncoupled from other components at the same point, then this default bandwidth may greatly overestimate the true bandwidth, with a substantial penalty in performance. For such domains, use method setBandwidth to specify the bandwidth before passing this domain to the Sim1D or OneDim constructor.

Definition at line 129 of file Domain1D.h.

Referenced by OneDim::resize().

 virtual void init ( )
inlinevirtual

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 in ReactingSurf1D, Surf1D, OutletRes1D, Symm1D, Empty1D, Inlet1D, StFlow, and Bdry1D.

Definition at line 138 of file Domain1D.h.

Referenced by OneDim::init().

 virtual void resize ( size_t nv, size_t np )
inlinevirtual

Resize the domain to have nv components and np grid points.

This method is virtual so that subclasses can perform other actions required to resize the domain.

Reimplemented in StFlow.

Definition at line 148 of file Domain1D.h.

References Domain1D::locate().

Referenced by Domain1D::Domain1D(), StFlow::resize(), and StFlow::StFlow().

 Refiner& refiner ( )
inline

Return a reference to the grid refiner.

Definition at line 172 of file Domain1D.h.

Referenced by Sim1D::refine(), Sim1D::setGridMin(), and Sim1D::setRefineCriteria().

 size_t nComponents ( ) const
inline

Number of components at each grid point.

Definition at line 177 of file Domain1D.h.

 void checkComponentIndex ( size_t n ) const
inline

Check that the specified component index is in range Throws an exception if n is greater than nComponents()-1.

Definition at line 183 of file Domain1D.h.

 void checkComponentArraySize ( size_t nn ) const
inline

Check that an array size is at least nComponents() Throws an exception if nn is less than nComponents().

Used before calls which take an array pointer.

Definition at line 192 of file Domain1D.h.

 size_t nPoints ( ) const
inline

Number of grid points in this domain.

Definition at line 199 of file Domain1D.h.

 void checkPointIndex ( size_t n ) const
inline

Check that the specified point index is in range Throws an exception if n is greater than nPoints()-1.

Definition at line 205 of file Domain1D.h.

 void checkPointArraySize ( size_t nn ) const
inline

Check that an array size is at least nPoints() Throws an exception if nn is less than nPoints().

Used before calls which take an array pointer.

Definition at line 214 of file Domain1D.h.

 virtual std::string componentName ( size_t n ) const
inlinevirtual

Name of the nth component. May be overloaded.

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

Definition at line 221 of file Domain1D.h.

References Cantera::int2str().

 size_t componentIndex ( std::string name ) const
inline

index of component with name name.

Definition at line 240 of file Domain1D.h.

References Domain1D::componentName(), and Domain1D::nComponents().

 void setBounds ( size_t nl, const doublereal * lower, size_t nu, const doublereal * upper )
inline

Set the lower and upper bounds for each solution component.

Definition at line 254 of file Domain1D.h.

References Cantera::int2str().

 void setTolerances ( size_t nr, const doublereal * rtol, size_t na, const doublereal * atol, int ts = 0 )

set the error tolerances for all solution components.

Definition at line 16 of file Domain1D.cpp.

References Cantera::int2str().

 void setTolerances ( size_t n, doublereal rtol, doublereal atol, int ts = 0 )

set the error tolerances for solution component n.

Definition at line 34 of file Domain1D.cpp.

 void setTolerances ( doublereal rtol, doublereal atol, int ts = 0 )

set scalar error tolerances.

All solution components will have the same relative and absolute error tolerances.

Definition at line 47 of file Domain1D.cpp.

 doublereal rtol ( size_t n )
inline

Relative tolerance of the nth component.

Definition at line 285 of file Domain1D.h.

 doublereal atol ( size_t n )
inline

Absolute tolerance of the nth component.

Definition at line 290 of file Domain1D.h.

 doublereal upperBound ( size_t n ) const
inline

Upper bound on the nth component.

Definition at line 295 of file Domain1D.h.

Referenced by Cantera::bound_step(), and Inlet1D::save().

 doublereal lowerBound ( size_t n ) const
inline

Lower bound on the nth component.

Definition at line 300 of file Domain1D.h.

Referenced by Cantera::bound_step(), and Inlet1D::save().

 void initTimeInteg ( doublereal dt, const doublereal * x0 )
inline

Prepare to do time stepping with time step dt.

Copy the internally-stored solution at the last time step to array x0.

Definition at line 310 of file Domain1D.h.

References Domain1D::loc().

Referenced by OneDim::initTimeInteg().

inline

Prepare to solve the steady-state problem.

Set the internally-stored reciprocal of the time step to 0,0

Definition at line 319 of file Domain1D.h.

inline

Definition at line 324 of file Domain1D.h.

 bool transient ( )
inline

True if not in steady-state mode.

Definition at line 329 of file Domain1D.h.

 void needJacUpdate ( )

Set this if something has changed in the governing equations (e.g.

Signal that the current Jacobian is no longer valid.

the value of a constant has been changed, so that the last-computed Jacobian is no longer valid. Note: see file OneDim.cpp for the implementation of this method.

Definition at line 391 of file OneDim.cpp.

References OneDim::jacobian(), OneDim::saveStats(), and MultiJac::setAge().

 void evalss ( doublereal * x, doublereal * r, integer * mask )
inline

Evaluate the steady-state residual at all points, even if in transient mode.

Used only to print diagnostic output.

Definition at line 345 of file Domain1D.h.

References Domain1D::eval(), and Cantera::npos.

 void eval ( size_t j, doublereal * x, doublereal * r, integer * mask, doublereal rdt = 0.0 )
virtual

Evaluate the residual function at point j.

If j == npos, evaluate the residual function at all points.

Parameters
 j Grid point j x Soln vector. This is the input. r residual this is the output.

Reimplemented in FreeFlame, AxiStagnFlow, ReactingSurf1D, Surf1D, OutletRes1D, Symm1D, Empty1D, and Inlet1D.

Definition at line 80 of file Domain1D.cpp.

References ckr::min(), and Cantera::npos.

Referenced by Domain1D::evalss().

 virtual void update ( doublereal * x )
inlinevirtual

Does nothing.

Definition at line 373 of file Domain1D.h.

 virtual void save ( XML_Node & o, const doublereal *const sol )
inlinevirtual

Save the current solution for this domain into an XML_Node.

Base class version of the general domain1D save function. This base class version will throw an error condition. Inherited classes will know how to save the solution vector.

Parameters
 o XML_Node to save the solution to. sol Current value of the solution vector. The object will pick out which part of the solution vector pertains to this object.

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

Definition at line 401 of file Domain1D.h.

 void locate ( )
inline

Find the index of the first grid point in this domain, and the start of its variables in the global solution vector.

Definition at line 413 of file Domain1D.h.

References Domain1D::lastPoint(), Domain1D::loc(), Domain1D::locate(), and Domain1D::m_iloc.

Referenced by Domain1D::linkLeft(), Domain1D::locate(), and Domain1D::resize().

 virtual size_t loc ( size_t j = 0 ) const
inlinevirtual

Location of the start of the local solution vector in the global solution vector,.

Definition at line 438 of file Domain1D.h.

References Domain1D::m_iloc.

 size_t firstPoint ( ) const
inline

The index of the first (i.e., left-most) grid point belonging to this domain.

Definition at line 446 of file Domain1D.h.

 size_t lastPoint ( ) const
inline

The index of the last (i.e., right-most) grid point belonging to this domain.

Definition at line 454 of file Domain1D.h.

 void linkLeft ( Domain1D * left )
inline

Set the left neighbor to domain 'left.

' Method 'locate' is called to update the global positions of this domain and all those to its right.

Definition at line 463 of file Domain1D.h.

References Domain1D::left(), and Domain1D::locate().

Referenced by Domain1D::append().

 void linkRight ( Domain1D * right )
inline

Set the right neighbor to domain 'right.

'

Definition at line 471 of file Domain1D.h.

References Domain1D::right().

Referenced by Domain1D::append().

 void append ( Domain1D * right )
inline

Append domain 'right' to this one, and update all links.

Definition at line 478 of file Domain1D.h.

 Domain1D* left ( ) const
inline

Return a pointer to the left neighbor.

Definition at line 486 of file Domain1D.h.

 Domain1D* right ( ) const
inline

Return a pointer to the right neighbor.

Definition at line 493 of file Domain1D.h.

 double prevSoln ( size_t n, size_t j ) const
inline

Value of component n at point j in the previous solution.

Definition at line 500 of file Domain1D.h.

Referenced by ReactingSurf1D::eval().

 void setID ( const std::string & s )
inline

Specify an identifying tag for this domain.

Definition at line 507 of file Domain1D.h.

References Domain1D::m_id.

Referenced by StFlow::StFlow().

 void setDesc ( const std::string & s )
inline

Specify descriptive text for this domain.

Definition at line 522 of file Domain1D.h.

 void showSolution ( const doublereal * x )
virtual

Print the solution.

Reimplemented in ReactingSurf1D, Surf1D, OutletRes1D, Empty1D, StFlow, and Inlet1D.

Definition at line 148 of file Domain1D.cpp.

References Cantera::writelog().

 void _getInitialSoln ( doublereal * x )
virtual

Writes some or all initial solution values into the global solution array, beginning at the location pointed to by x.

This method is called by the Sim1D constructor, and allows default values or ones that have been set locally prior to installing this domain into the container to be written to the global solution vector.

Reimplemented in ReactingSurf1D, Surf1D, OutletRes1D, Symm1D, Empty1D, Inlet1D, StFlow, and Bdry1D.

Definition at line 198 of file Domain1D.cpp.

Referenced by Sim1D::Sim1D().

 doublereal initialValue ( size_t n, size_t j )
virtual

Initial value of solution component n at grid point j.

Definition at line 207 of file Domain1D.cpp.

 virtual void _finalize ( const doublereal * x )
inlinevirtual

In some cases, a domain may need to set parameters that depend on the initial solution estimate.

In such cases, the parameters may be set in method _finalize. This method is called just before the Newton solver is called, and the x array is guaranteed to be the local solution vector for this domain that will be used as the initial guess. If no such parameters need to be set, then method _finalize does not need to be overloaded.

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

Definition at line 599 of file Domain1D.h.

Referenced by Sim1D::finalize().

## Member Data Documentation

 size_t m_iloc
protected

Starting location within the solution vector for unknowns that correspond to this domain.

Remember there may be multiple domains associated with this problem

Definition at line 628 of file Domain1D.h.

Referenced by Domain1D::loc(), and Domain1D::locate().

 std::string m_id
protected

Identity tag for the domain.

Definition at line 635 of file Domain1D.h.

Referenced by StFlow::save(), and Domain1D::setID().

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