Cantera  2.3.0
Public Member Functions | Public Attributes | List of all members
GasTransportData Class Reference

Transport data for a single gas-phase species which can be used in mixture-averaged or multicomponent transport models. More...

#include <TransportData.h>

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

Public Member Functions

 GasTransportData (const std::string &geometry, double diameter, double well_depth, double dipole=0.0, double polarizability=0.0, double rot_relax=0.0, double acentric=0.0)
 Construct a GasTransportData object using MKS units for all parameters. More...
 
void setCustomaryUnits (const std::string &geometry, double diameter, double well_depth, double dipole=0.0, double polarizability=0.0, double rot_relax=0.0, double acentric=0.0)
 Set the parameters using "customary" units: diameter in Angstroms, well depth in Kelvin, dipole in Debye, and polarizability in Angstroms^3. More...
 
virtual void validate (const Species &species)
 Check transport data for invalid parameters such as a geometry inconsistent with the atomic composition, non-positive diameter, or negative values for well depth, dipole, polarizability, or rotational relaxation number. More...
 

Public Attributes

std::string geometry
 A string specifying the molecular geometry. More...
 
double diameter
 The Lennard-Jones collision diameter [m]. More...
 
double well_depth
 The Lennard-Jones well depth [J]. More...
 
double dipole
 The permanent dipole moment of the molecule [Coulomb-m]. Default 0.0. More...
 
double polarizability
 The polarizability of the molecule [m^3]. Default 0.0. More...
 
double rotational_relaxation
 The rotational relaxation number (the number of collisions it takes to equilibrate the rotational degrees of freedom with the temperature). More...
 
double acentric_factor
 Pitzer's acentric factor [dimensionless]. Default 0.0. More...
 

Detailed Description

Transport data for a single gas-phase species which can be used in mixture-averaged or multicomponent transport models.

Definition at line 29 of file TransportData.h.

Constructor & Destructor Documentation

◆ GasTransportData()

GasTransportData ( const std::string &  geometry,
double  diameter,
double  well_depth,
double  dipole = 0.0,
double  polarizability = 0.0,
double  rot_relax = 0.0,
double  acentric = 0.0 
)

Construct a GasTransportData object using MKS units for all parameters.

Definition at line 24 of file TransportData.cpp.

Member Function Documentation

◆ setCustomaryUnits()

void setCustomaryUnits ( const std::string &  geometry,
double  diameter,
double  well_depth,
double  dipole = 0.0,
double  polarizability = 0.0,
double  rot_relax = 0.0,
double  acentric = 0.0 
)

Set the parameters using "customary" units: diameter in Angstroms, well depth in Kelvin, dipole in Debye, and polarizability in Angstroms^3.

These are the units used in in CK-style input files.

Definition at line 38 of file TransportData.cpp.

References GasTransportData::acentric_factor, Cantera::Boltzmann, GasTransportData::diameter, GasTransportData::dipole, GasTransportData::geometry, Cantera::lightSpeed, GasTransportData::polarizability, GasTransportData::rotational_relaxation, and GasTransportData::well_depth.

◆ validate()

void validate ( const Species species)
virtual

Check transport data for invalid parameters such as a geometry inconsistent with the atomic composition, non-positive diameter, or negative values for well depth, dipole, polarizability, or rotational relaxation number.

Reimplemented from TransportData.

Definition at line 52 of file TransportData.cpp.

References Species::composition, GasTransportData::diameter, GasTransportData::dipole, GasTransportData::geometry, Species::name, GasTransportData::polarizability, GasTransportData::rotational_relaxation, and GasTransportData::well_depth.

Member Data Documentation

◆ geometry

std::string geometry

A string specifying the molecular geometry.

One of atom, linear, or nonlinear.

Definition at line 56 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ diameter

double diameter

The Lennard-Jones collision diameter [m].

Definition at line 59 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ well_depth

double well_depth

The Lennard-Jones well depth [J].

Definition at line 62 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ dipole

double dipole

The permanent dipole moment of the molecule [Coulomb-m]. Default 0.0.

Definition at line 65 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ polarizability

double polarizability

The polarizability of the molecule [m^3]. Default 0.0.

Definition at line 68 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ rotational_relaxation

double rotational_relaxation

The rotational relaxation number (the number of collisions it takes to equilibrate the rotational degrees of freedom with the temperature).

Default 0.0.

Definition at line 73 of file TransportData.h.

Referenced by GasTransport::getTransportData(), GasTransportData::setCustomaryUnits(), and GasTransportData::validate().

◆ acentric_factor

double acentric_factor

Pitzer's acentric factor [dimensionless]. Default 0.0.

Definition at line 76 of file TransportData.h.

Referenced by GasTransport::getTransportData(), and GasTransportData::setCustomaryUnits().


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