 |
Cantera
3.1.0a1
|
|
Cantera
3.1.0a1
|
An outlet. More...
#include <Boundary1D.h>
Public Member Functions | |
| Outlet1D (shared_ptr< Solution > solution, const string &id="") | |
| string | domainType () const override |
| Domain type flag. More... | |
| void | init () override |
| Initialize. More... | |
| void | eval (size_t jg, double *xg, double *rg, integer *diagg, double rdt) override |
| Evaluate the residual function at point j. More... | |
| shared_ptr< SolutionArray > | asArray (const double *soln) const override |
| Save the state of this domain as a SolutionArray. More... | |
 Public Member Functions inherited from Boundary1D | |
| bool | isConnector () override |
| True if the domain is a connector domain. More... | |
| virtual void | setTemperature (double t) |
| Set the temperature. More... | |
| virtual double | temperature () |
| Temperature [K]. More... | |
| virtual size_t | nSpecies () |
| virtual void | setMoleFractions (const string &xin) |
| Set the mole fractions by specifying a string. More... | |
| virtual void | setMoleFractions (const double *xin) |
| Set the mole fractions by specifying an array. More... | |
| virtual double | massFraction (size_t k) |
| Mass fraction of species k. More... | |
| virtual void | setMdot (double mdot) |
| Set the total mass flow rate. More... | |
| virtual void | setSpreadRate (double V0) |
| Set tangential velocity gradient [1/s] at this boundary. More... | |
| virtual double | spreadRate () |
| Tangential velocity gradient [1/s] at this boundary. More... | |
| virtual double | mdot () |
| The total mass flow rate [kg/m2/s]. More... | |
| void | setupGrid (size_t n, const double *z) override |
| called to set up initial grid, and after grid refinement More... | |
| void | fromArray (SolutionArray &arr, double *soln) override |
| Restore the solution for this domain from a SolutionArray. More... | |
| Public Member Functions inherited from Domain1D | |
| Domain1D (size_t nv=1, size_t points=1, double time=0.0) | |
| Constructor. More... | |
| Domain1D (const Domain1D &)=delete | |
| Domain1D & | operator= (const Domain1D &)=delete |
| string | type () const |
| String indicating the domain implemented. More... | |
| size_t | domainIndex () |
| The left-to-right location of this domain. More... | |
| void | setSolution (shared_ptr< Solution > sol) |
| Set the solution manager. More... | |
| virtual void | setKinetics (shared_ptr< Kinetics > kin) |
| Set the kinetics manager. More... | |
| virtual void | setTransport (shared_ptr< Transport > trans) |
| Set transport model to existing instance. More... | |
| const OneDim & | container () const |
| The container holding this domain. More... | |
| void | setContainer (OneDim *c, size_t index) |
| Specify the container object for this domain, and the position of this domain in the list. More... | |
| void | setBandwidth (int bw=-1) |
| Set the Jacobian bandwidth. See the discussion of method bandwidth(). More... | |
| size_t | bandwidth () |
| Set the Jacobian bandwidth for this domain. More... | |
| 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. More... | |
| virtual void | resize (size_t nv, size_t np) |
| Resize the domain to have nv components and np grid points. More... | |
| Refiner & | refiner () |
| Return a reference to the grid refiner. More... | |
| size_t | nComponents () const |
| Number of components at each grid point. More... | |
| void | checkComponentIndex (size_t n) const |
| Check that the specified component index is in range. More... | |
| void | checkComponentArraySize (size_t nn) const |
| Check that an array size is at least nComponents(). More... | |
| size_t | nPoints () const |
| Number of grid points in this domain. More... | |
| void | checkPointIndex (size_t n) const |
| Check that the specified point index is in range. More... | |
| void | checkPointArraySize (size_t nn) const |
| Check that an array size is at least nPoints(). More... | |
| virtual string | componentName (size_t n) const |
| Name of the nth component. May be overloaded. More... | |
| void | setComponentName (size_t n, const string &name) |
| virtual size_t | componentIndex (const string &name) const |
| index of component with name name. More... | |
| 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. More... | |
| void | setSteadyTolerances (double rtol, double atol, size_t n=npos) |
| Set tolerances for steady-state mode. More... | |
| double | rtol (size_t n) |
| Relative tolerance of the nth component. More... | |
| double | atol (size_t n) |
| Absolute tolerance of the nth component. More... | |
| double | steady_rtol (size_t n) |
| Steady relative tolerance of the nth component. More... | |
| double | steady_atol (size_t n) |
| Steady absolute tolerance of the nth component. More... | |
| double | transient_rtol (size_t n) |
| Transient relative tolerance of the nth component. More... | |
| double | transient_atol (size_t n) |
| Transient absolute tolerance of the nth component. More... | |
| double | upperBound (size_t n) const |
| Upper bound on the nth component. More... | |
| double | lowerBound (size_t n) const |
| Lower bound on the nth component. More... | |
| void | initTimeInteg (double dt, const double *x0) |
| Prepare to do time stepping with time step dt. More... | |
| void | setSteadyMode () |
| Prepare to solve the steady-state problem. More... | |
| bool | steady () |
| True if in steady-state mode. More... | |
| bool | transient () |
| True if not in steady-state mode. More... | |
| 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. More... | |
| 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) |
| shared_ptr< SolutionArray > | toArray (bool normalize=false) const |
| Save the state of this domain to a SolutionArray. More... | |
| void | fromArray (const shared_ptr< SolutionArray > &arr) |
| Restore the solution for this domain from a SolutionArray. More... | |
| shared_ptr< Solution > | solution () const |
| Return thermo/kinetics/transport manager used in the domain. More... | |
| 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. More... | |
| virtual size_t | loc (size_t j=0) const |
| Location of the start of the local solution vector in the global solution vector,. More... | |
| size_t | firstPoint () const |
| The index of the first (that is, left-most) grid point belonging to this domain. More... | |
| size_t | lastPoint () const |
| The index of the last (that is, right-most) grid point belonging to this domain. More... | |
| void | linkLeft (Domain1D *left) |
| Set the left neighbor to domain 'left. More... | |
| void | linkRight (Domain1D *right) |
| Set the right neighbor to domain 'right.'. More... | |
| void | append (Domain1D *right) |
| Append domain 'right' to this one, and update all links. More... | |
| Domain1D * | left () const |
| Return a pointer to the left neighbor. More... | |
| Domain1D * | right () const |
| Return a pointer to the right neighbor. More... | |
| double | prevSoln (size_t n, size_t j) const |
| Value of component n at point j in the previous solution. More... | |
| void | setID (const string &s) |
| Specify an identifying tag for this domain. More... | |
| string | id () const |
| virtual void | show (std::ostream &s, const double *x) |
| Print the solution. More... | |
| virtual void | show (const double *x) |
| Print the solution. More... | |
| 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 | _getInitialSoln (double *x) |
| Writes some or all initial solution values into the global solution array, beginning at the location pointed to by x. More... | |
| virtual double | initialValue (size_t n, size_t j) |
| Initial value of solution component n at grid point j. More... | |
| virtual void | _finalize (const double *x) |
| In some cases, a domain may need to set parameters that depend on the initial solution estimate. More... | |
| void | forceFullUpdate (bool update) |
| In some cases, for computational efficiency some properties (such as transport coefficients) may not be updated during Jacobian evaluations. More... | |
| void | setData (shared_ptr< vector< double >> &data) |
| Set shared data pointer. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Boundary1D | |
| void | _init (size_t n) |
| Protected Member Functions inherited from Domain1D | |
| virtual AnyMap | getMeta () const |
| Retrieve meta data. More... | |
| virtual void | setMeta (const AnyMap &meta) |
| Retrieve meta data. More... | |
| Protected Attributes inherited from Boundary1D | |
| StFlow * | m_flow_left = nullptr |
| StFlow * | m_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 |
| ThermoPhase * | m_phase_left = nullptr |
| ThermoPhase * | m_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 More... | |
| double | m_rdt = 0.0 |
| size_t | m_nv = 0 |
| size_t | m_points |
| Number of grid points. More... | |
| 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 |
| OneDim * | m_container = nullptr |
| size_t | m_index |
| size_t | m_iloc = 0 |
| Starting location within the solution vector for unknowns that correspond to this domain. More... | |
| size_t | m_jstart = 0 |
| Domain1D * | m_left = nullptr |
| Domain1D * | m_right = nullptr |
| string | m_id |
| Identity tag for the domain. More... | |
| unique_ptr< Refiner > | m_refiner |
| vector< string > | m_name |
| int | m_bw = -1 |
| bool | m_force_full_update = false |
| shared_ptr< Solution > | m_solution |
| Composite thermo/kinetics/transport handler. More... | |
|
inlineoverridevirtual |
Domain type flag.
string. Reimplemented from Boundary1D.
Definition at line 246 of file Boundary1D.h.
|
overridevirtual |
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 Boundary1D.
Definition at line 358 of file Boundary1D.cpp.
|
overridevirtual |
Evaluate the residual function at point j.
If j == npos, evaluate the residual function at all points.
This function must be implemented in classes derived from Domain1D.
| j | Grid point at which to update the residual | |
| [in] | x | State vector |
| [out] | r | residual vector |
| [out] | mask | Boolean mask indicating whether each solution component has a time derivative (1) or not (0). |
| [in] | rdt | Reciprocal of the timestep (rdt=0 implies steady- state.) |
Reimplemented from Domain1D.
Definition at line 373 of file Boundary1D.cpp.
|
overridevirtual |
Save the state of this domain as a SolutionArray.
| soln | local solution vector for this domain |
Reimplemented from Domain1D.
Definition at line 406 of file Boundary1D.cpp.
1.9.1