feedtwin.model.spec.ParamSpec Class Reference

Collaboration diagram for feedtwin.model.spec.ParamSpec:

Public Member Functions
bool	applies_to (self, str model)
str	si_unit (self)

Public Attributes
	dimension

Static Public Attributes
bool	required = True
Param	default = None
float	minimum = None
float	maximum = None
tuple	models = ()

Detailed Description

One parameter a component accepts.

Args:
    name: Identifier used in configs and code.
    dimension: What it measures -- ``"pressure"``, ``"length"``,
        ``"flow_coefficient"``. Enforced: a value in the wrong kind of unit
        is rejected at load with both dimensions named.
    description: What it is, in a sentence. Shown in the inspector, so it is
        user-facing text and not an implementation note.
    required: Whether a configuration must supply it.
    default: Used when it is absent. A spec that is neither required nor
        defaulted describes an optional parameter with no value, which is
        usually a mistake.
    minimum, maximum: Bounds in canonical units. A bore of -3 mm should fail
        at load rather than inside a Reynolds number.
    models: Fidelity models this parameter applies to. Empty means all of
        them, which is the common case.

Definition at line 61 of file spec.py.

Member Function Documentation

applies_to()

bool feedtwin.model.spec.ParamSpec.applies_to	(		self,
		str	model )

Definition at line 90 of file spec.py.

References feedtwin.model.curve.CurveSpec.models, and models.

si_unit()

str feedtwin.model.spec.ParamSpec.si_unit

(

self

)

Definition at line 94 of file spec.py.

Member Data Documentation

default

Param feedtwin.model.spec.ParamSpec.default = None

static

Definition at line 85 of file spec.py.

Referenced by feedtwin.model.spec.OptionSpec.__post_init__().

dimension

feedtwin.model.spec.ParamSpec.dimension

Definition at line 95 of file spec.py.

maximum

float feedtwin.model.spec.ParamSpec.maximum = None

static

Definition at line 87 of file spec.py.

minimum

float feedtwin.model.spec.ParamSpec.minimum = None

static

Definition at line 86 of file spec.py.

models

tuple feedtwin.model.spec.ParamSpec.models = ()

static

Definition at line 88 of file spec.py.

Referenced by feedtwin.model.spec.ComponentSpec.__post_init__(), feedtwin.model.spec.OptionSpec.applies_to(), applies_to(), feedtwin.model.spec.ComponentSpec.defaults(), feedtwin.model.spec.ComponentSpec.validate(), feedtwin.model.spec.ComponentSpec.validate_curves(), and feedtwin.model.spec.ComponentSpec.validate_options().

required

bool feedtwin.model.spec.ParamSpec.required = True

static

Definition at line 84 of file spec.py.

---

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

• lib/feedtwin/feedtwin/model/spec.py