DynamicCyl Class

class thermal.dynamic.DynamicCyl(name='')

Finite element thermal solver for 2D cylindrical geometry.

Methods

compute(time)	Run thermal calculations
initialize()	Initialize solver.
invalidate()	Set the solver back to uninitialized state.

Attributes

Receivers

inHeat

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

Providers

outHeatFlux	Provider of the computed heat flux [W/m²].
outTemperature	Provider of the computed temperature [K].
outThermalConductivity	Provider of the computed thermal conductivity [W/(m×K)].

Other

algorithm	Chosen matrix factorization algorithm
elapsed_time	Alias for time (obsolete).
empty_elements	Should empty regions (e.g. air) be included into computation domain?.
geometry	Geometry provided to the solver
id	Id of the solver object.
initialized	True if the solver has been initialized.
inittemp	Initial temperature (K)
iterative	Iterative matrix parameters (see IterativeParams)
logfreq	Frequency of iteration progress reporting
lumping	Chosen mass matrix type from lumped or non-lumped (consistent)
mesh	Mesh provided to the solver
methodparam	0.5 - Crank-Nicolson method, 0 - explicit method, 1 - implicit method
rebuildfreq	Frequency of rebuild mass
temperature_boundary	Boundary conditions for the constant temperature
time	Time of calculations performed so far since the last solver invalidation.
timestep	Time step (ns)

Descriptions

Method Details

DynamicCyl.compute(time)

Run thermal calculations

DynamicCyl.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

DynamicCyl.invalidate()

Set the solver back to uninitialized state.

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

Receiver Details

DynamicCyl.inHeat = <property object>

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 receiver 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

DynamicCyl.outHeatFlux(mesh, interpolation='default') = <property object>

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

DynamicCyl.outTemperature(mesh, interpolation='default') = <property object>

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

DynamicCyl.outThermalConductivity(mesh, interpolation='default') = <property object>

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

DynamicCyl.algorithm = <property object>

Chosen matrix factorization algorithm

DynamicCyl.elapsed_time = <property object>

Alias for time (obsolete).

DynamicCyl.empty_elements = <property object>

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

DynamicCyl.geometry = <property object>

Geometry provided to the solver

DynamicCyl.id = <property object>

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

DynamicCyl.initialized = <property object>

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.

DynamicCyl.inittemp = <property object>

Initial temperature (K)

DynamicCyl.iterative = <property object>

Iterative matrix parameters (see IterativeParams)

DynamicCyl.logfreq = <property object>

Frequency of iteration progress reporting

DynamicCyl.lumping = <property object>

Chosen mass matrix type from lumped or non-lumped (consistent)

DynamicCyl.mesh = <property object>

Mesh provided to the solver

DynamicCyl.methodparam = <property object>

0.5 - Crank-Nicolson method, 0 - explicit method, 1 - implicit method

Type:

Initial parameter determining the calculation method

DynamicCyl.rebuildfreq = <property object>

Frequency of rebuild mass

DynamicCyl.temperature_boundary = <property object>

Boundary conditions for the constant temperature

This field holds a list of boundary conditions for the solver. You may access and alter its 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

DynamicCyl.time = <property object>

Time of calculations performed so far since the last solver invalidation.

DynamicCyl.timestep = <property object>

Time step (ns)