Commit 0b28ae99 authored by Philipp Arras's avatar Philipp Arras
Browse files

Rework docstring

parent 7f7571cb
......@@ -25,18 +25,19 @@ class EnergyAdapter(Energy):
Parameters
-----------
op: Operator with a scalar target domain
The expression computing the energy from the input data
constants: list of strings (default: [])
position: Field or MultiField
The position where the minimization process is started.
op: EnergyOperator
The expression computing the energy from the input data.
constants: list of strings
The component names of the operator's input domain which are assumed
to be constant during the minimization process.
If the operator's input domain is not a MultiField, this must be empty.
want_metric: bool (default: False)
if True, the class will provide a `metric` property. This should only
Default: [].
want_metric: bool
If True, the class will provide a `metric` property. This should only
be enabled if it is required, because it will most likely consume
additional resources.
additional resources. Default: False.
"""
def __init__(self, position, op, constants=[], want_metric=False):
......
......@@ -27,6 +27,7 @@ from .simple_linear_operators import VdotOperator
class EnergyOperator(Operator):
"""Operator which has a scalar domain as target domain."""
_target = DomainTuple.scalar_domain()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment