Inheritance diagram for feedtwin.model.component.Component:

Collaboration diagram for feedtwin.model.component.Component:

Public Member Functions
ComponentInstance	instance (self)
int	n_residuals (self)
Sequence[float]	residuals (self, EvalContext ctx)
Mapping[str, float]	outputs (self, EvalContext ctx)

Detailed Description

An evaluable component. **Provisional** -- see the module docstring.

Implementations are built from a :class:`ComponentInstance` and hold their
parameters as plain floats in canonical units, resolved once at
construction. Nothing in a residual evaluation should be looking up a unit.

Definition at line 87 of file component.py.

Member Function Documentation

◆ instance()

ComponentInstance feedtwin.model.component.Component.instance ( self )

The configuration this was built from.

Definition at line 96 of file component.py.

◆ n_residuals()

int feedtwin.model.component.Component.n_residuals ( self )

How many equations this contributes to the system.

Definition at line 101 of file component.py.

◆ outputs()

Mapping[str, float] feedtwin.model.component.Component.outputs	(		self,
		EvalContext	ctx )

Derived quantities worth reporting -- velocity, Reynolds number,
cavitation index. Never used by the solver; consumed by frames and
reports.

Definition at line 109 of file component.py.

◆ residuals()

Sequence[float] feedtwin.model.component.Component.residuals	(		self,
		EvalContext	ctx )

Residuals, zero when the component's equations are satisfied.

Definition at line 105 of file component.py.

The documentation for this class was generated from the following file:

lib/feedtwin/feedtwin/model/component.py