Variables

Currently, EdelweissFE supports two types of variables: FieldVariables, i.e., variables associated with spatial positions, and scalar variables, not associated with a spatial position. The latter may be used for, e.g., Lagrangian multipliers.

Relevant modules:

• edelweissfe.variables.fieldvariable

• edelweissfe.variables.scalarvariable

class edelweissfe.variables.fieldvariable.FieldVariable(node, field)

This is a basic field variable, tied to a spatial position. Currently, it is a placeholder used to indicate the presence field variables at a certain location, and associate them with e.g, nodes. Furthermore, it allows us to adress them by their unique id (= hash value). Unlike ScalarVariables, FieldVariable does not directly holds any results/values, but rather, for performance reasons, we store results in cumulative Fields, such as NodeField.

class edelweissfe.variables.scalarvariable.ScalarVariable(name)

A basic scalar variable, not tied to a spatial position.

Parameters:

name (str) – The name under which the model holds it (see scalarVariables), the same in every run of the model: a restart checkpoint stores its value under this name, and the numbering of the degrees of freedom names it so (dofNumberingDigest).