CapacitanceCyl Class

class electrical.capacitance.CapacitanceCyl(name='')

Finite element AC electric solver for 2D cylindrical geometry.

Methods

compute()	Run calculations
get_S11([Z0])	Get scattering parameter <i>S</i><sub>11</sub> at the current frequency
get_ac_current([nact, active])	Get total current flowing through active region (mA)
get_impedance()	Get the impedance at the current frequency
initialize()	Initialize solver.
invalidate()	Set the solver back to uninitialized state.

Attributes

Receivers

inDifferentialConductivity	Receiver of the electrical conductivity required for computations [S/m].
inTemperature	Receiver of the temperature required for computations [K].

Providers

outAcCurrentDensity	Provider of the computed AC current density amplitude [kA/cm²].
outAcVoltage	Provider of the computed AC voltage amplitude [V].

Other

empty_elements	Should empty regions (e.g. air) be included into computation domain?.
frequency	AC modulation frequency (MHz)
geometry	Geometry provided to the solver
id	Id of the solver object.
initialized	True if the solver has been initialized.
mesh	Mesh provided to the solver
voltage_boundary	Boundary conditions of the first kind (constant potential)

Descriptions

Method Details

CapacitanceCyl.compute()

Run calculations

CapacitanceCyl.get_S11(Z0=50.0)

Get scattering parameter <i>S</i>₁₁ at the current frequency

Parameters:

Z0 (complex) – reference impedance (default 50 Ω)

Returns:

computed S11 parameter

Return type:

complex

CapacitanceCyl.get_ac_current(nact=0, active=False)

Get total current flowing through active region (mA)

Parameters:

• nact (int) – number of the active region

• active (bool) – if true, the active current (in phase with the voltage) is returned, otherwise the total current is returned

Returns:

computed total current (mA)

Return type:

complex

CapacitanceCyl.get_impedance()

Get the impedance at the current frequency

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

CapacitanceCyl.invalidate()

Set the solver back to uninitialized state.

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

Receiver Details

CapacitanceCyl.inDifferentialConductivity = <property object>

Receiver of the electrical conductivity required for computations [S/m].

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inDifferentialConductivity = other_solver.outConductivity

See also

Receciver class: plask.flow.ConductivityReceiverCyl

Provider class: plask.flow.ConductivityProviderCyl

Data filter: plask.filter.ConductivityFilterCyl

CapacitanceCyl.inTemperature = <property object>

Receiver of the temperature required for computations [K].

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inTemperature = other_solver.outTemperature

See also

Receciver class: plask.flow.TemperatureReceiverCyl

Provider class: plask.flow.TemperatureProviderCyl

Data filter: plask.filter.TemperatureFilterCyl

Provider Details

CapacitanceCyl.outAcCurrentDensity(mesh, interpolation='default') = <property object>

Provider of the computed AC current density amplitude [kA/cm²].

Parameters:

• mesh (mesh) – Target mesh to get the field at.

• interpolation (str) – Requested interpolation method.

Returns:

Data with the AC current density amplitude on the specified mesh [kA/cm²].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inAcCurrentDensity = solver.outAcCurrentDensity

Obtain the provided field:

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

See also

Provider class: plask.flow.AcCurrentDensityProviderCyl

Receciver class: plask.flow.AcCurrentDensityReceiverCyl

CapacitanceCyl.outAcVoltage(mesh, interpolation='default') = <property object>

Provider of the computed AC voltage amplitude [V].

Parameters:

• mesh (mesh) – Target mesh to get the field at.

• interpolation (str) – Requested interpolation method.

Returns:

Data with the AC voltage amplitude on the specified mesh [V].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inAcVoltage = solver.outAcVoltage

Obtain the provided field:

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

See also

Provider class: plask.flow.AcVoltageProviderCyl

Receciver class: plask.flow.AcVoltageReceiverCyl

Attribute Details

CapacitanceCyl.empty_elements = <property object>

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

CapacitanceCyl.frequency = <property object>

AC modulation frequency (MHz)

CapacitanceCyl.geometry = <property object>

Geometry provided to the solver

CapacitanceCyl.id = <property object>

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

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

CapacitanceCyl.mesh = <property object>

Mesh provided to the solver

CapacitanceCyl.voltage_boundary = <property object>

Boundary conditions of the first kind (constant potential)

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.voltage_boundary.clear()
>>> solver.voltage_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.voltage_boundary[0].value = different_value
>>> solver.voltage_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.voltage_boundary[1].value == different_value
True