meta.shockley.thermoelectric.ThermoElectric2D Class Reference

Inheritance diagram for meta.shockley.thermoelectric.ThermoElectric2D:

Collaboration diagram for meta.shockley.thermoelectric.ThermoElectric2D:

Static Public Attributes
	thermal = attribute(_Thermal.__name__+"()")
	electrical = attribute(_Electrical.__name__+"()")
float	tfreq = 6.0

Static Protected Attributes
	_Thermal = thermal.static.Static2D
	_Electrical = electrical.shockley.Shockley2D
Static Protected Attributes inherited from meta.shockley.thermoelectric.ThermoElectric
	_Thermal = None
	_Electrical = None

Properties
	outTemperature
	outHeatFlux
	outThermalConductivity
	outVoltage
	outCurrentDensity
	outHeat
	outConductivity

Additional Inherited Members
Public Member Functions inherited from meta.shockley.thermoelectric.ThermoElectric
	__init__ (self, name)
	reconnect (self)
	load_xpl (self, xpl, manager)
	on_initialize (self)
	on_invalidate (self)
	compute (self, save=True, invalidate=True, group='ThermoElectric')
	get_total_current (self, nact=0)
	save (self, filename=None, group='ThermoElectric')
	get_temperature (self)
	get_voltage (self)
	get_vertical_voltage (self, at=0)
	get_junction_currents (self, refine=16, interpolation='linear')
	plot_temperature (self, geometry_color='0.75', mesh_color=None, geometry_alpha=0.35, mesh_alpha=0.15, geometry_lw=1.0, mesh_lw=1.0, **kwargs)
	plot_voltage (self, geometry_color='0.75', mesh_color=None, geometry_alpha=0.35, mesh_alpha=0.15, geometry_lw=1.0, mesh_lw=1.0, **kwargs)
	plot_vertical_voltage (self, at=0., **kwargs)
	plot_junction_current (self, refine=16, bounds=True, interpolation='linear', label=None, **kwargs)
Public Member Functions inherited from plask::Solver
bool	initCalculation ()
	This should be called on beginning of each calculation method to ensure that solver will be initialized.
	Solver (const std::string &name="")
	Construct uninitialized solver.
virtual	~Solver ()
	Virtual destructor (for subclassing). Do nothing.
virtual void	loadConfiguration (XMLReader &source, Manager &manager)
	Load configuration from given source.
void	parseStandardConfiguration (XMLReader &source, Manager &manager, const std::string &expected_msg="solver configuration element")
	Load standard configuration (geometry, mesh) tags from source.
bool	isInitialized ()
	Check if solver is already initialized.
void	invalidate ()
	This method should be and is called if something important was changed: calculation space, mesh, etc.
virtual std::string	getClassName () const =0
	Get name of solver.
std::string	getId () const
	Get solver id.
std::string	getName () const
virtual std::string	getClassDescription () const
	Get a description of this solver.
template<typename ArgT = double, typename ValT = double>
DataLog< ArgT, ValT >	dataLog (const std::string &chart_name, const std::string &axis_arg_name, const std::string &axis_val_name)
template<typename ArgT = double, typename ValT = double>
DataLog< ArgT, ValT >	dataLog (const std::string &axis_arg_name, const std::string &axis_val_name)
template<typename ... Args>
void	writelog (LogLevel level, std::string msg, Args &&... params) const
	Log a message for this solver.
Public Attributes inherited from meta.shockley.thermoelectric.ThermoElectric
	thermal
	electrical
	tfreq
Protected Member Functions inherited from meta.shockley.thermoelectric.ThermoElectric
	_read_attr (self, tag, attr, solver, type=None, pyattr=None)
	_parse_fem_tag (self, tag, manager, solver)
	_parse_xpl (self, tag, manager)
	_save_thermoelectric (self, h5file, group)
	_plot_hbounds (self, solver)
	_get_defines_info (self)
	_get_info (self)
Protected Member Functions inherited from plask::Solver
virtual void	onInitialize ()
	Initialize the solver.
virtual void	onInvalidate ()
	This method is called by invalidate() to reset stored values.
Static Protected Member Functions inherited from meta.shockley.thermoelectric.ThermoElectric
	_iter_levels (geometry, mesh, *required)
Protected Attributes inherited from plask::Solver
bool	initialized
	true only if solver is initialized

Detailed Description

Thermo-electric calculations solver without the optical part.

This solver performs under-threshold thermo-electrical computations.
It computes electric current flow and temperature distribution in a self-
consistent loop until desired convergence is reached.

The computations can be executed using `compute` method, after which
the results may be save to the HDF5 file with `save` or presented visually
using ``plot_...`` methods. If ``save`` parameter of the :meth:`compute` method
is *True* the fields are saved automatically after the computations.
The file name is based on the name of the executed script with suffix denoting
either the launch time or the identifier of a batch job if a batch system
(like SLURM, OpenPBS, or SGE) is used.

Definition at line 514 of file thermoelectric.py.

Member Data Documentation

_Electrical

meta.shockley.thermoelectric.ThermoElectric2D._Electrical = electrical.shockley.Shockley2D

staticprotected

Definition at line 532 of file thermoelectric.py.

_Thermal

meta.shockley.thermoelectric.ThermoElectric2D._Thermal = thermal.static.Static2D

staticprotected

Definition at line 531 of file thermoelectric.py.

electrical

meta.shockley.thermoelectric.ThermoElectric2D.electrical = attribute(_Electrical.__name__+"()")

static

Definition at line 560 of file thermoelectric.py.

tfreq

float meta.shockley.thermoelectric.ThermoElectric2D.tfreq = 6.0

static

Definition at line 565 of file thermoelectric.py.

thermal

meta.shockley.thermoelectric.ThermoElectric2D.thermal = attribute(_Thermal.__name__+"()")

static

Definition at line 555 of file thermoelectric.py.

Property Documentation

outConductivity

meta.shockley.thermoelectric.ThermoElectric2D.outConductivity

static

Initial value:

=  property(lambda self: self.electrical.outConductivity,
                               doc=_Electrical.outConductivity.__doc__)

Definition at line 552 of file thermoelectric.py.

outCurrentDensity

meta.shockley.thermoelectric.ThermoElectric2D.outCurrentDensity

static

Initial value:

=  property(lambda self: self.electrical.outCurrentDensity,
                                 doc=_Electrical.outCurrentDensity.__doc__)

Definition at line 546 of file thermoelectric.py.

outHeat

meta.shockley.thermoelectric.ThermoElectric2D.outHeat

static

Initial value:

=  property(lambda self: self.electrical.outHeat,
                       doc=_Electrical.outHeat.__doc__)

Definition at line 549 of file thermoelectric.py.

outHeatFlux

meta.shockley.thermoelectric.ThermoElectric2D.outHeatFlux

static

Initial value:

=  property(lambda self: self.thermal.outHeatFlux,
                           doc=_Thermal.outHeatFlux.__doc__)

Definition at line 537 of file thermoelectric.py.

outTemperature

meta.shockley.thermoelectric.ThermoElectric2D.outTemperature

static

Initial value:

=  property(lambda self: self.thermal.outTemperature,
                              doc=_Thermal.outTemperature.__doc__)

Definition at line 534 of file thermoelectric.py.

outThermalConductivity

meta.shockley.thermoelectric.ThermoElectric2D.outThermalConductivity

static

Initial value:

=  property(lambda self: self.thermal.outThermalConductivity,
                                      doc=_Thermal.outThermalConductivity.__doc__)

Definition at line 540 of file thermoelectric.py.

outVoltage

meta.shockley.thermoelectric.ThermoElectric2D.outVoltage

static

Initial value:

=  property(lambda self: self.electrical.outVoltage,
                          doc=_Electrical.outVoltage.__doc__)

Definition at line 543 of file thermoelectric.py.

---

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

• solvers/meta/shockley/thermoelectric.py