Cantera  2.5.1
Public Member Functions | Protected Attributes | List of all members
WallBase Class Reference

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

#include <Wall.h>

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

Public Member Functions

 WallBase (const WallBase &)=delete
 
WallBaseoperator= (const WallBase &)=delete
 
virtual std::string type () const
 String indicating the wall model implemented. More...
 
virtual double vdot (double t)
 Rate of volume change (m^3/s) for the adjacent reactors. More...
 
virtual double Q (double t)
 Heat flow rate through the wall (W). More...
 
double area ()
 Area in (m^2). More...
 
virtual void setArea (double a)
 Set the area [m^2]. More...
 
double getArea () const
 Get the area [m^2]. More...
 
bool install (ReactorBase &leftReactor, ReactorBase &rightReactor)
 Install the wall between two reactors or reservoirs. More...
 
virtual void initialize ()
 Called just before the start of integration. More...
 
virtual bool ready ()
 True if the wall is correctly configured and ready to use. More...
 
ReactorBaseleft () const
 Return a reference to the Reactor or Reservoir to the left of the wall. More...
 
const ReactorBaseright ()
 Return a reference to the Reactor or Reservoir to the right of the wall. More...
 

Protected Attributes

ReactorBasem_left
 
ReactorBasem_right
 
std::vector< ReactorSurface > m_surf
 
double m_area
 

Detailed Description

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

Definition at line 28 of file Wall.h.

Member Function Documentation

◆ type()

virtual std::string type ( ) const
inlinevirtual

String indicating the wall model implemented.

Usually corresponds to the name of the derived class.

Reimplemented in Wall.

Definition at line 39 of file Wall.h.

◆ vdot()

virtual double vdot ( double  t)
inlinevirtual

Rate of volume change (m^3/s) for the adjacent reactors.

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

Reimplemented in Wall.

Definition at line 48 of file Wall.h.

◆ Q()

virtual double Q ( double  t)
inlinevirtual

Heat flow rate through the wall (W).

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

Reimplemented in Wall.

Definition at line 57 of file Wall.h.

◆ area()

double area ( )
inline

Area in (m^2).

Definition at line 62 of file Wall.h.

◆ setArea()

void setArea ( double  a)
virtual

Set the area [m^2].

Definition at line 31 of file Wall.cpp.

◆ getArea()

double getArea ( ) const
inline

Get the area [m^2].

Redundant function (same as WallBase::area()).

Deprecated:
To be removed after Cantera 2.5.

Definition at line 74 of file Wall.h.

References Cantera::warn_deprecated().

◆ install()

bool install ( ReactorBase leftReactor,
ReactorBase rightReactor 
)

Install the wall between two reactors or reservoirs.

Definition at line 16 of file Wall.cpp.

References ReactorBase::addWall().

◆ initialize()

virtual void initialize ( )
inlinevirtual

Called just before the start of integration.

Definition at line 85 of file Wall.h.

Referenced by Reactor::initialize().

◆ ready()

virtual bool ready ( )
inlinevirtual

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

Definition at line 88 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 93 of file Wall.h.

◆ right()

const ReactorBase& right ( )
inline

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

Definition at line 98 of file Wall.h.


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