Class SolidTransport implements transport properties for solids. More...

#include <SolidTransport.h>

Inheritance diagram for SolidTransport:

Collaboration diagram for SolidTransport:

Public Member Functions
	SolidTransport ()
	Default constructor.

	SolidTransport (const SolidTransport &right)
	Copy Constructor.

virtual	~SolidTransport ()
	Destructor.

SolidTransport &	operator= (const SolidTransport &right)
	Assignment operator.

virtual Transport *	duplMyselfAsTransport () const
	Duplication routine for objects which inherit from Transport.

virtual int	model () const
	Transport model.

virtual doublereal	thermalConductivity ()
	Returns the mixture thermal conductivity in W/m/K.

virtual void	getMixDiffCoeffs (doublereal *const d)
	Returns a vector of mixture averaged diffusion coefficients.

virtual void	getMobilities (doublereal *const mobil)
	Compute the electrical mobilities of the species from the diffusion coefficients, using the Einstein relation.

virtual void	setParameters (const int n, const int k, const doublereal *const p)
	Set model parameters for derived classes.

virtual doublereal	electricalConductivity ()
	The electrical conductivity (Siemens/m).

thermo_t &	thermo ()
	Phase object.

bool	ready ()
	Returns true if the transport manager is ready for use.

void	setNDim (const int ndim)
	Set the number of dimensions to be expected in flux expressions.

size_t	nDim () const
	Return the number of dimensions in flux expressions.

void	checkSpeciesIndex (size_t k) const
	Check that the specified species index is in range Throws an exception if k is greater than nSpecies()

void	checkSpeciesArraySize (size_t kk) const
	Check that an array size is at least nSpecies() Throws an exception if kk is less than nSpecies().

virtual doublereal	getElectricConduct ()
	Compute the mixture electrical conductivity (S m-1) at the current conditions of the phase (Siemens m-1)

virtual void	getElectricCurrent (int ndim, const doublereal grad_T, int ldx, const doublereal grad_X, int ldf, const doublereal grad_V, doublereal current)
	Compute the electric current density in A/m^2.

virtual void	getSpeciesFluxes (size_t ndim, const doublereal const grad_T, size_t ldx, const doublereal const grad_X, size_t ldf, doublereal *const fluxes)
	Get the species diffusive mass fluxes wrt to the specified solution averaged velocity, given the gradients in mole fraction and temperature.

virtual void	getSpeciesFluxesES (size_t ndim, const doublereal grad_T, size_t ldx, const doublereal grad_X, size_t ldf, const doublereal grad_Phi, doublereal fluxes)
	Get the species diffusive mass fluxes wrt to the mass averaged velocity, given the gradients in mole fraction, temperature and electrostatic potential.

virtual void	getSpeciesVdiff (size_t ndim, const doublereal grad_T, int ldx, const doublereal grad_X, int ldf, doublereal *Vdiff)
	Get the species diffusive velocities wrt to the mass averaged velocity, given the gradients in mole fraction and temperature.

virtual void	getSpeciesVdiffES (size_t ndim, const doublereal grad_T, int ldx, const doublereal grad_X, int ldf, const doublereal grad_Phi, doublereal Vdiff)
	Get the species diffusive velocities wrt to the mass averaged velocity, given the gradients in mole fraction, temperature, and electrostatic potential.

virtual void	getMolarFluxes (const doublereal const state1, const doublereal const state2, const doublereal delta, doublereal *const cfluxes)
	Get the molar fluxes [kmol/m^2/s], given the thermodynamic state at two nearby points.

virtual void	getMassFluxes (const doublereal state1, const doublereal state2, doublereal delta, doublereal *mfluxes)
	Get the mass fluxes [kg/m^2/s], given the thermodynamic state at two nearby points.

virtual void	getThermalDiffCoeffs (doublereal *const dt)
	Return a vector of Thermal diffusion coefficients [kg/m/sec].

virtual void	getBinaryDiffCoeffs (const size_t ld, doublereal *const d)
	Returns the matrix of binary diffusion coefficients [m^2/s].

virtual void	getMultiDiffCoeffs (const size_t ld, doublereal *const d)
	Return the Multicomponent diffusion coefficients. Units: [m^2/s].

virtual void	getMixDiffCoeffsMole (doublereal *const d)
	Returns a vector of mixture averaged diffusion coefficients.

virtual void	getMixDiffCoeffsMass (doublereal *const d)
	Returns a vector of mixture averaged diffusion coefficients.

void	setVelocityBasis (VelocityBasis ivb)
	Sets the velocity basis.

VelocityBasis	getVelocityBasis () const
	Gets the velocity basis.

Transport Properties
virtual doublereal	viscosity ()
	The viscosity in Pa-s.

virtual void	getSpeciesViscosities (doublereal *const visc)
	Returns the pure species viscosities.

virtual doublereal	bulkViscosity ()
	The bulk viscosity in Pa-s.

virtual doublereal	ionConductivity ()
	The ionic conductivity in 1/ohm/m.

virtual void	getSpeciesIonConductivity (doublereal *const ionCond)
	Returns the pure species ionic conductivity.

virtual void	mobilityRatio (double *mobRat)
	Returns the pointer to the mobility ratios of the species in the phase.

virtual void	getSpeciesMobilityRatio (double **mobRat)
	Returns the pure species limit of the mobility ratios.

virtual void	selfDiffusion (doublereal *const selfDiff)
	Returns the self diffusion coefficients of the species in the phase.

virtual void	getSpeciesSelfDiffusion (double **selfDiff)
	Returns the pure species self diffusion in solution of each species.

virtual void	getFluidMobilities (doublereal *const mobil_f)
	Get the fluid mobilities (s kmol/kg).

Protected Member Functions
Transport manager construction
These methods are used internally during construction.
virtual bool	initGas (GasTransportParams &tr)
	Called by TransportFactory to set parameters.

virtual bool	initLiquid (LiquidTransportParams &tr)
	Called by TransportFactory to set parameters.

void	setThermo (thermo_t &thermo)
	Specifies the ThermPhase object.

void	finalize ()
	Enable the transport object for use.

Protected Attributes
thermo_t *	m_thermo
	pointer to the object representing the phase

bool	m_ready
	true if finalize has been called

size_t	m_nsp
	Number of species.

size_t	m_nDim
	Number of dimensions used in flux expressions.

int	m_velocityBasis
	Velocity basis from which diffusion velocities are computed.

Private Attributes
size_t	m_nmobile
	number of mobile species

vector_fp	m_Adiff
	Coefficient for the diffusivity of species within a solid.

vector_fp	m_Ndiff
	Temperature power coefficient for the diffusivity of species in a solid.

vector_fp	m_Ediff
	Arrhenius factor for the species diffusivities of a solid.

vector_int	m_sp
	Index of mobile species to global species.

doublereal	m_Alam
	Coefficient for the thermal conductivity of a solid.

doublereal	m_Nlam
	Temperature power coefficient for the thermal conductivity of a solid.

doublereal	m_Elam
	Arrhenius factor for the thermal conductivity of a solid.

vector_fp	m_work
	extra fp array of length nSpecies()

Friends
class	TransportFactory

Detailed Description

Class SolidTransport implements transport properties for solids.

Definition at line 27 of file SolidTransport.h.

Constructor & Destructor Documentation

SolidTransport ( )

Default constructor.

Definition at line 21 of file SolidTransport.cpp.

Referenced by SolidTransport::duplMyselfAsTransport().

SolidTransport ( const SolidTransport & right )

Copy Constructor.

Parameters

right Object to be copied

Definition at line 38 of file SolidTransport.cpp.

~SolidTransport ( )

virtual

Destructor.

Definition at line 34 of file SolidTransport.cpp.

Member Function Documentation

SolidTransport & operator= ( const SolidTransport & right )

Assignment operator.

This is NOT a virtual function.

Parameters

right Reference to Transport object to be copied into the current one.

Definition at line 56 of file SolidTransport.cpp.

References SolidTransport::m_Adiff, SolidTransport::m_Alam, SolidTransport::m_Ediff, SolidTransport::m_Elam, SolidTransport::m_Ndiff, SolidTransport::m_Nlam, SolidTransport::m_nmobile, SolidTransport::m_sp, and Transport::operator=().

Transport * duplMyselfAsTransport ( ) const

virtual

Duplication routine for objects which inherit from Transport.

This virtual routine can be used to duplicate Transport objects inherited from Transport even if the application only has a pointer to Transport to work with.

These routines are basically wrappers around the derived copy constructor.

Reimplemented from Transport.

Definition at line 75 of file SolidTransport.cpp.

References SolidTransport::SolidTransport().

virtual int model ( ) const

inlinevirtual

Transport model.

The transport model is the set of equations used to compute the transport properties. This virtual method returns an integer flag that identifies the transport model implemented. The base class returns 0.

Reimplemented from Transport.

Definition at line 66 of file SolidTransport.h.

doublereal thermalConductivity ( )

virtual

Returns the mixture thermal conductivity in W/m/K.

Units are in W / m K or equivalently kg m / s3 K

Returns: returns thermal conductivity in W/m/K.

Reimplemented from Transport.

Definition at line 129 of file SolidTransport.cpp.

References SolidTransport::m_Alam, SolidTransport::m_Elam, SolidTransport::m_Nlam, Transport::m_thermo, and Phase::temperature().

void getMixDiffCoeffs ( doublereal *const d )

virtual

Returns a vector of mixture averaged diffusion coefficients.

Mixture-averaged diffusion coefficients [m^2/s]. If the

transport manager implements a mixture-averaged diffusion model, then this method returns the array of mixture-averaged diffusion coefficients. Otherwise it throws an exception.

Parameters

d	Return vector of mixture averaged diffusion coefficients Units = m2/s. Length = n_sp

Reimplemented from Transport.

Definition at line 146 of file SolidTransport.cpp.

References SolidTransport::m_Adiff, SolidTransport::m_Ediff, SolidTransport::m_Ndiff, SolidTransport::m_nmobile, SolidTransport::m_sp, Transport::m_thermo, Phase::nSpecies(), and Phase::temperature().

Referenced by SolidTransport::getMobilities().

void getMobilities ( doublereal *const mobil )

virtual

Compute the electrical mobilities of the species from the diffusion coefficients, using the Einstein relation.

Frequently, but not always, the mobility is calculated from the diffusion coefficient using the Einstein relation

\[ \mu^e_k = \frac{F D_k}{R T} \]

units (m^2/V/s).

Parameters

mobil Returns the mobilities of the species in array mobil_e. The array must be dimensioned at least as large as the number of species.

Reimplemented from Transport.

Definition at line 113 of file SolidTransport.cpp.

References Cantera::Boltzmann, SolidTransport::getMixDiffCoeffs(), Transport::m_thermo, Phase::nSpecies(), and Phase::temperature().

Referenced by SolidTransport::electricalConductivity().

void setParameters	(	const int	type,
		const int	k,
		const doublereal *const	p
	)

virtual

Set model parameters for derived classes.

This method may be derived in subclasses to set model-specific parameters. The primary use of this class is to set parameters while in the middle of a calculation without actually having to dynamically cast the base Transport pointer.

Parameters

type	Specifies the type of parameters to set 0 : Diffusion coefficient 1 : Thermal Conductivity The rest are currently unused.
k	Species index to set the parameters on
p	Vector of parameters. The length of the vector varies with the parameterization

Reimplemented from Transport.

Definition at line 81 of file SolidTransport.cpp.

References SolidTransport::m_Adiff, SolidTransport::m_Alam, SolidTransport::m_Ediff, SolidTransport::m_Elam, SolidTransport::m_Ndiff, SolidTransport::m_Nlam, SolidTransport::m_nmobile, SolidTransport::m_sp, Transport::m_thermo, SolidTransport::m_work, and Phase::nSpecies().

doublereal electricalConductivity ( )

virtual

The electrical conductivity (Siemens/m).

Reimplemented from Transport.

Definition at line 159 of file SolidTransport.cpp.

References Phase::charge(), SolidTransport::getMobilities(), Transport::m_thermo, SolidTransport::m_work, Phase::molarDensity(), Phase::moleFraction(), and Phase::nSpecies().

thermo_t& thermo ( )

inlineinherited

Phase object.

Every transport manager is designed to compute properties for a specific phase of a mixture, which might be a liquid solution, a gas mixture, a surface, etc. This method returns a reference to the object representing the phase itself.

Definition at line 239 of file TransportBase.h.

References Transport::m_thermo.

Referenced by Transport::setThermo().

bool ready ( )

inherited

Returns true if the transport manager is ready for use.

Definition at line 75 of file TransportBase.cpp.

References Transport::m_ready.

Referenced by Transport::finalize(), and Transport::setThermo().

void setNDim ( const int ndim )

inherited

Set the number of dimensions to be expected in flux expressions.

Internal memory will be set with this value.

Parameters

ndim	Number of dimensions in flux expressions

Definition at line 83 of file TransportBase.cpp.

References Transport::m_nDim.

size_t nDim ( ) const

inlineinherited

Return the number of dimensions in flux expressions.

Returns: Returns the number of dimensions

Definition at line 261 of file TransportBase.h.

References Transport::m_nDim.

void checkSpeciesIndex ( size_t k ) const

inherited

Check that the specified species index is in range Throws an exception if k is greater than nSpecies()

Definition at line 88 of file TransportBase.cpp.

References Transport::m_nsp.

void checkSpeciesArraySize ( size_t kk ) const

inherited

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

Used before calls which take an array pointer.

Definition at line 95 of file TransportBase.cpp.

References Transport::m_nsp.

virtual doublereal viscosity ( )

inlinevirtualinherited

The viscosity in Pa-s.

Reimplemented in SimpleTransport, LiquidTransport, AqueousTransport, WaterTransport, FtnTransport, and GasTransport.

Definition at line 283 of file TransportBase.h.

ndim	The number of spatial dimensions (1, 2, or 3).
grad_T	The temperature gradient (ignored in this model).
ldx	Leading dimension of the grad_X array.
grad_X	The gradient of the mole fraction
ldf	Leading dimension of the grad_V and current vectors.
grad_V	The electrostatic potential gradient.
current	The electric current in A/m^2. This is a vector of length ndim

ndim	Number of dimensions in the flux expressions
grad_T	Gradient of the temperature (length = ndim)
ldx	Leading dimension of the grad_X array (usually equal to m_nsp but not always)
grad_X	Gradients of the mole fraction Flat vector with the m_nsp in the inner loop. length = ldx * ndim
ldf	Leading dimension of the fluxes array (usually equal to m_nsp but not always)
fluxes	Output of the diffusive mass fluxes Flat vector with the m_nsp in the inner loop. length = ldx * ndim

state1	Array of temperature, density, and mass fractions for state 1.
state2	Array of temperature, density, and mass fractions for state 2.
delta	Distance from state 1 to state 2 (m).
cfluxes	Output array containing the diffusive molar fluxes of species from state1 to state2. This is a flat vector with the m_nsp in the inner loop. length = ldx * ndim. Units are [kmol/m^2/s].

ld	Inner stride for writing the two dimension diffusion coefficients into a one dimensional vector
d	Diffusion coefficient matrix (must be at least m_k * m_k in length.

ld	The dimension of the inner loop of d (usually equal to m_nsp)
d	flat vector of diffusion coefficients, fortran ordering. d[ld*j+i] is the D_ij diffusion coefficient (the diffusion coefficient for species i due to species j).

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation