Base class for 'walls' (walls, pistons, etc.) connecting reactors. More...

#include <Wall.h>

Inheritance diagram for WallBase:

Detailed Description

Base class for 'walls' (walls, pistons, etc.) connecting reactors.

Definition at line 23 of file Wall.h.

Public Member Functions
	WallBase (shared_ptr< ReactorBase > r0, shared_ptr< ReactorBase > r1, const string &name="(none)")

string	type () const override
	String indicating the connector implemented.

virtual double	expansionRate ()
	Rate of volume change (m^3/s) for the adjacent reactors at current reactor network time.

virtual double	heatRate ()
	Heat flow rate through the wall (W) at current reactor network time.

double	area ()
	Area in (m^2).

virtual void	setArea (double a)
	Set the area [m^2].

virtual void	initialize ()
	Called just before the start of integration.

virtual bool	ready ()
	True if the wall is correctly configured and ready to use.

ReactorBase &	left () const
	Return a reference to the Reactor or Reservoir to the left of the wall.

ReactorBase &	right ()
	Return a reference to the Reactor or Reservoir to the right of the wall.

void	setSimTime (double time)
	Set current reactor network time.

virtual void	addExpansionRateJacobian (SparseTriplets &trips, size_t row, double coeff, bool includePressureSpecies=true)
	Add Jacobian terms proportional to derivatives of the wall expansion rate.

virtual void	addHeatRateJacobian (SparseTriplets &trips, size_t row, double coeff)
	Add Jacobian terms proportional to derivatives of the wall heat rate.

	ConnectorNode (const string &name="(none)")
	Transitional constructor.

	ConnectorNode (shared_ptr< ReactorBase > r0, shared_ptr< ReactorBase > r1, const string &name="(none)")
	Instantiate a ConnectorNode object with associated ReactorBase objects.

	ConnectorNode (const ConnectorNode &)=delete

Public Member Functions inherited from ConnectorNode
	ConnectorNode (const string &name="(none)")
	Transitional constructor.

	ConnectorNode (shared_ptr< ReactorBase > r0, shared_ptr< ReactorBase > r1, const string &name="(none)")
	Instantiate a ConnectorNode object with associated ReactorBase objects.

	ConnectorNode (const ConnectorNode &)=delete

ConnectorNode &	operator= (const ConnectorNode &)=delete

virtual string	type () const
	String indicating the connector implemented.

string	name () const
	Retrieve connector name.

void	setName (const string &name)
	Set connector name.

void	setDefaultName (map< string, int > &counts)
	Set the default name of a connector. Returns `false` if it was previously set.

Protected Attributes
ReactorBase *	m_left = nullptr

ReactorBase *	m_right = nullptr

double	m_time = 0.0
	current reactor network time

double	m_area = 1.0

Protected Attributes inherited from ConnectorNode
pair< shared_ptr< ReactorBase >, shared_ptr< ReactorBase > >	m_nodes
	Pair of reactors forming end points of the connector.

string	m_name
	ConnectorNode name.

bool	m_defaultNameSet = false
	`true` if default name has been previously set.

Constructor & Destructor Documentation

◆ WallBase()

WallBase	(	shared_ptr< ReactorBase >	r0,
		shared_ptr< ReactorBase >	r1,
		const string &	name = `"(none)"`
	)

Definition at line 13 of file Wall.cpp.

Member Function Documentation

◆ type()

string type ( ) const

inlineoverridevirtual

String indicating the connector implemented.

Usually corresponds to the name of the derived class.

Reimplemented from ConnectorNode.

Definition at line 30 of file Wall.h.

◆ expansionRate()

virtual double expansionRate ( )

inlinevirtual

Rate of volume change (m^3/s) for the adjacent reactors at current reactor network time.

This method is called by Reactor::evalWalls(). Base class method does nothing (that is, constant volume), but may be overloaded.

Since: New in Cantera 3.0.

Reimplemented in Wall.

Definition at line 41 of file Wall.h.

◆ heatRate()

virtual double heatRate ( )

inlinevirtual

Heat flow rate through the wall (W) at current reactor network time.

This method is called by Reactor::evalWalls(). Base class method does nothing (that is, an adiabatic wall), but may be overloaded.

Since: New in Cantera 3.0.

Reimplemented in Wall.

Definition at line 51 of file Wall.h.

◆ area()

double area ( )

inline

Area in (m^2).

Definition at line 56 of file Wall.h.

◆ setArea()

void setArea ( double a )

virtual

Set the area [m^2].

Definition at line 26 of file Wall.cpp.

◆ initialize()

virtual void initialize ( )

inlinevirtual

Called just before the start of integration.

Definition at line 64 of file Wall.h.

◆ ready()

virtual bool ready ( )

inlinevirtual

True if the wall is correctly configured and ready to use.

Definition at line 67 of file Wall.h.

◆ left()

ReactorBase & left ( ) const

inline

Return a reference to the Reactor or Reservoir to the left of the wall.

Definition at line 72 of file Wall.h.

◆ right()

ReactorBase & right ( )

inline

Return a reference to the Reactor or Reservoir to the right of the wall.

Definition at line 77 of file Wall.h.

◆ setSimTime()

void setSimTime ( double time )

inline

Set current reactor network time.

Since: New in Cantera 3.0.

Definition at line 85 of file Wall.h.

◆ addExpansionRateJacobian()

virtual void addExpansionRateJacobian	(	SparseTriplets &	trips,
		size_t	row,
		double	coeff,
		bool	includePressureSpecies = `true`
	)

inlinevirtual

Add Jacobian terms proportional to derivatives of the wall expansion rate.

Adds entries for coeff * d(expansionRate)/dy_j to the specified global row of the reactor network Jacobian. The wall supplies scalar derivatives with respect to left and right pressures, while adjacent reactors supply pressure derivatives with respect to their state variables.

Parameters

[in,out]	trips	Sparse Jacobian entries. Implementations append entries using global row and column indices in the reactor network.
	row	Global row index receiving these chain-rule terms.
	coeff	Multiplicative factor applied to `d(expansionRate)/dy_j`.
	includePressureSpecies	Include pressure derivatives with respect to species state variables when pressure is a derived quantity. These terms may be dense and are controlled by preconditioner sparsity settings.

Since: New in Cantera 4.0.

Reimplemented in Wall.

Definition at line 104 of file Wall.h.

◆ addHeatRateJacobian()

virtual void addHeatRateJacobian	(	SparseTriplets &	trips,
		size_t	row,
		double	coeff
	)

inlinevirtual

Add Jacobian terms proportional to derivatives of the wall heat rate.

Adds entries for coeff * d(heatRate)/dy_j to the specified global row of the reactor network Jacobian. The wall supplies scalar derivatives with respect to left and right temperatures, while adjacent reactors supply temperature derivatives with respect to their state variables.

Parameters

[in,out]	trips	Sparse Jacobian entries. Implementations append entries using global row and column indices in the reactor network.
	row	Global row index receiving these chain-rule terms.
	coeff	Multiplicative factor applied to `d(heatRate)/dy_j`.

Since: New in Cantera 4.0.

Reimplemented in Wall.

Definition at line 119 of file Wall.h.

◆ ConnectorNode() [1/2]

ConnectorNode ( const string & name = "(none)" )

inline

Transitional constructor.

Todo:: Implement deprecation warning.

Definition at line 32 of file ConnectorNode.h.

◆ ConnectorNode() [2/2]

ConnectorNode	(	shared_ptr< ReactorBase >	r0,
		shared_ptr< ReactorBase >	r1,
		const string &	name = `"(none)"`
	)

inline

Instantiate a ConnectorNode object with associated ReactorBase objects.

Parameters

r0	First reactor.
r1	Second reactor.
name	Name of the connector.

Definition at line 38 of file ConnectorNode.h.

Member Data Documentation

◆ m_left

ReactorBase* m_left = nullptr

protected

Definition at line 122 of file Wall.h.

◆ m_right

ReactorBase* m_right = nullptr

protected

Definition at line 123 of file Wall.h.

◆ m_time

double m_time = 0.0

protected

current reactor network time

Definition at line 126 of file Wall.h.

◆ m_area

double m_area = 1.0

protected

Definition at line 128 of file Wall.h.

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

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ WallBase()

Member Function Documentation

◆ type()

◆ expansionRate()

◆ heatRate()

◆ area()

◆ setArea()

◆ initialize()

◆ ready()

◆ left()

◆ right()

◆ setSimTime()

◆ addExpansionRateJacobian()

◆ addHeatRateJacobian()

◆ ConnectorNode() [1/2]

◆ ConnectorNode() [2/2]

Member Data Documentation

◆ m_left

◆ m_right

◆ m_time

◆ m_area