Receivers¶

Providers¶

Other¶

Method Details¶

StaticCyl.compute(loops=0)¶

Run thermal calculations

StaticCyl.initialize()¶

Initialize solver.

This method manually initialized the solver and sets initialized to True. Normally calling it is not necessary, as each solver automatically initializes itself when needed.

Returns:	solver initialized state prior to this method call.
Return type:	bool

StaticCyl.invalidate()¶

Set the solver back to uninitialized state.

This method frees the memory allocated by the solver and sets initialized to False.

Receiver Details¶

StaticCyl.inHeat¶

Receiver of the heat sources density required for computations [W/m³].

You will find usage details in the documentation of the receiver class HeatReceiverCyl.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inHeat = other_solver.outHeat

See also

Receciver class: plask.flow.HeatReceiverCyl

Provider class: plask.flow.HeatProviderCyl

Data filter: plask.filter.HeatFilterCyl

Provider Details¶

StaticCyl.outHeatFlux(mesh, interpolation='default')¶

Provider of the computed heat flux [W/m²].

Parameters:	mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method.
Returns:	Data with the heat flux on the specified mesh [W/m²].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inHeatFlux = solver.outHeatFlux

Obtain the provided field:

>>> solver.outHeatFlux(mesh)
<plask.Data at 0x1234567>

See also

Provider class: plask.flow.HeatFluxProviderCyl

Receciver class: plask.flow.HeatFluxReceiverCyl

StaticCyl.outTemperature(mesh, interpolation='default')¶

Provider of the computed temperature [K].

Parameters:	mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method.
Returns:	Data with the temperature on the specified mesh [K].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inTemperature = solver.outTemperature

Obtain the provided field:

>>> solver.outTemperature(mesh)
<plask.Data at 0x1234567>

See also

Provider class: plask.flow.TemperatureProviderCyl

Receciver class: plask.flow.TemperatureReceiverCyl

StaticCyl.outThermalConductivity(mesh, interpolation='default')¶

Provider of the computed thermal conductivity [W/(m×K)].

Parameters:	mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method.
Returns:	Data with the thermal conductivity on the specified mesh [W/(m×K)].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inThermalConductivity = solver.outThermalConductivity

Obtain the provided field:

>>> solver.outThermalConductivity(mesh)
<plask.Data at 0x1234567>

See also

Provider class: plask.flow.ThermalConductivityProviderCyl

Receciver class: plask.flow.ThermalConductivityReceiverCyl

Attribute Details¶

StaticCyl.algorithm¶

Chosen matrix factorization algorithm

StaticCyl.convection_boundary¶

Convective boundary conditions

This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:

place	Boundary condition location (plask.mesh.RectangularBase2D.Boundary).
value	Boundary condition value (thermal.static.Convection).

When you add new boundary condition, you may use two-argument append, or prepend methods, or three-argument insert method, where you separately specify the place and the value. See the below example for clarification.

Example

>>> solver.convection_boundary.clear()
>>> solver.convection_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.convection_boundary[0].value = different_value
>>> solver.convection_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.convection_boundary[1].value == different_value
True

class Convection¶

Convective boundary condition value.

StaticCyl.err¶

Maximum estimated error

StaticCyl.geometry¶

Geometry provided to the solver

StaticCyl.heatflux_boundary¶

Boundary conditions for the constant heat flux

This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:

place	Boundary condition location (plask.mesh.RectangularBase2D.Boundary).
value	Boundary condition value.

When you add new boundary condition, you may use two-argument append, or prepend methods, or three-argument insert method, where you separately specify the place and the value. See the below example for clarification.

Example

>>> solver.heatflux_boundary.clear()
>>> solver.heatflux_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.heatflux_boundary[0].value = different_value
>>> solver.heatflux_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.heatflux_boundary[1].value == different_value
True

StaticCyl.id¶

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

StaticCyl.include_empty¶

Should empty regions (e.g. air) be included into computation domain?

StaticCyl.initialized¶

True if the solver has been initialized. (read only)

Solvers usually get initialized at the beginning of the computations. You can clean the initialization state and free the memory by calling the invalidate() method.

StaticCyl.inittemp¶

Initial temperature

StaticCyl.itererr¶

Allowed residual iteration for iterative method

StaticCyl.iterlim¶

Maximum number of iterations for iterative method

StaticCyl.logfreq¶

Frequency of iteration progress reporting

StaticCyl.maxerr¶

Limit for the temperature updates

StaticCyl.mesh¶

Mesh provided to the solver

StaticCyl.radiation_boundary¶

Radiative boundary conditions

This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:

place	Boundary condition location (plask.mesh.RectangularBase2D.Boundary).
value	Boundary condition value (thermal.static.Radiation).

When you add new boundary condition, you may use two-argument append, or prepend methods, or three-argument insert method, where you separately specify the place and the value. See the below example for clarification.

Example

>>> solver.radiation_boundary.clear()
>>> solver.radiation_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.radiation_boundary[0].value = different_value
>>> solver.radiation_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.radiation_boundary[1].value == different_value
True

class Radiation¶

Radiative boundary condition value.

StaticCyl.temperature_boundary¶

Boundary conditions for the constant temperature

This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:

place	Boundary condition location (plask.mesh.RectangularBase2D.Boundary).
value	Boundary condition value.

When you add new boundary condition, you may use two-argument append, or prepend methods, or three-argument insert method, where you separately specify the place and the value. See the below example for clarification.

Example

>>> solver.temperature_boundary.clear()
>>> solver.temperature_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.temperature_boundary[0].value = different_value
>>> solver.temperature_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.temperature_boundary[1].value == different_value
True