Capacitance2D Class

class electrical.capacitance.Capacitance2D(name="")

Finite element AC electric solver for 2D Cartesian 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.
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

Capacitance2D.compute()

Run calculations

Capacitance2D.get_S11(Z0=50.0)

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

Parameters:Z0 (complex) – reference impedance (default 50 Ω)
Returns:computed S11 parameter
Return type:complex
Capacitance2D.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
Capacitance2D.get_impedance()

Get the impedance at the current frequency

Capacitance2D.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
Capacitance2D.invalidate()

Set the solver back to uninitialized state.

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

Receiver Details

Capacitance2D.inDifferentialConductivity

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

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inDifferentialConductivity = other_solver.outConductivity

See also

Receciver class: plask.flow.ConductivityReceiver2D

Provider class: plask.flow.ConductivityProvider2D

Data filter: plask.filter.ConductivityFilter2D

Capacitance2D.inTemperature

Receiver of the temperature required for computations [K].

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inTemperature = other_solver.outTemperature

See also

Receciver class: plask.flow.TemperatureReceiver2D

Provider class: plask.flow.TemperatureProvider2D

Data filter: plask.filter.TemperatureFilter2D

Provider Details

Capacitance2D.outAcCurrentDensity(mesh, interpolation='default')

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

Receciver class: plask.flow.AcCurrentDensityReceiver2D

Capacitance2D.outAcVoltage(mesh, interpolation='default')

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

Receciver class: plask.flow.AcVoltageReceiver2D

Attribute Details

Capacitance2D.empty_elements

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

Capacitance2D.frequency

AC modulation frequency (MHz)

Capacitance2D.geometry

Geometry provided to the solver

Capacitance2D.id

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type
Capacitance2D.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.

Capacitance2D.mesh

Mesh provided to the solver

Capacitance2D.voltage_boundary

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