$current-cluster

For current calculations, you have to define current regions ($current-regions) and current clusters on which certain current models ($current-models) are applied. As for the regions and quantum-regions, current-regions can be clustered. At least cluster number 1 has to be specified if the current has to be calculated at all.

The syntax of the region-cluster, quantum-cluster, and current-cluster is very similar. For more information on these specifiers see $region-cluster and $quantum-cluster.

$current-cluster                          optional
 cluster-number           integer         required
 region-numbers           integer_array   required
 deactivate-cluster       character       optional
$end_current-cluster                      optional

Explanation of specifiers

cluster-number
type:

integer >= 1

presence:

required

An integer number to refer to clustered geometry element.

region-numbers
type:

integer array containing integers >= 1

presence:

required

Region numbers belonging to cluster cluster-number.

deactivate-cluster
type:

character

presence:

optional

value:

yes or no

default:

no

Flag to switch off current clusters. Switching off current calculation means equilibrium simulation. This is a very convenient way to turn the current calculation off and on.

Example

!----------------------------------------------
$current-cluster
 cluster-number = 1     region-numbers = 1
 deactivate-cluster  = no
!deactivate-cluster  = yes
$end_current-cluster
!----------------------------------------------