feedtwin.comps.regulator.CurveRegulator Class Reference

Inheritance diagram for feedtwin.comps.regulator.CurveRegulator:

Collaboration diagram for feedtwin.comps.regulator.CurveRegulator:

Public Member Functions
float	outlet_setpoint (self, float mdot, FlowConditions flow)
Public Member Functions inherited from feedtwin.comps.regulator.Regulator
float	commanded_setpoint (self, FlowConditions flow)
float	supply_effect (self, FlowConditions flow)
float	lockup_pressure (self, FlowConditions|None flow=None)
float|None	seat_capacity (self, FlowConditions flow, float xT=XT_TYPICAL)
float|None	pinned_flow (self, float dp_available, FlowConditions flow)
dict[str, object]	seat_model (self, float xT=XT_TYPICAL)
float	pressure_drop (self, float mdot, FlowConditions flow)
float	total_dp (self, float mdot, FlowConditions flow)
float|None	flow_ceiling (self, FlowConditions flow)
bool	is_choked (self, float dp_available, FlowConditions flow)
bool	is_saturated (self, float mdot, FlowConditions flow)
dict[str, float]	diagnostics (self, float mdot, FlowConditions flow)
list[Violation]	check (self)
list[Violation]	envelope_violations (self, float mdot, FlowConditions flow)
Public Member Functions inherited from feedtwin.comps.base.HydraulicComponent
None	__init__ (self, ComponentInstance instance)
str	id (self)
str	type (self)
float	static_head (self, FlowConditions flow)
float	signal (self, FlowConditions flow, str name, float default=1.0)
bool	isolates (self, Mapping[str, float]|None signals=None)
int	n_residuals (self)
Sequence[float]	residuals (self, EvalContext ctx)
Mapping[str, float]	outputs (self, EvalContext ctx)
FlowConditions	conditions (self, PortState port, Mapping[str, float] signals)
str	__repr__ (self)

Additional Inherited Members
Public Attributes inherited from feedtwin.comps.base.HydraulicComponent
	instance = instance
	p = instance.si_params()
	opt = dict(instance.options)
Static Public Attributes inherited from feedtwin.comps.base.HydraulicComponent
str	inlet_port = "inlet"
str	outlet_port = "outlet"
bool	symmetric = False
	conditions_provider = None
Protected Member Functions inherited from feedtwin.comps.regulator.Regulator
GasCv|None	_gas_seat (self, FlowConditions flow)
float	_seat_dp (self, float magnitude, FlowConditions flow)
float	_creep (self, float magnitude)
float	_rated_multiple (self, float mdot)

Detailed Description

Outlet against flow, read from a datasheet curve or a flow bench.

Supersedes the two-coefficient form when a real curve exists, which is the
same principle as every other ``measured`` model in this library: data in
front of a correlation, never blended with it.

Definition at line 651 of file regulator.py.

Member Function Documentation

outlet_setpoint()

float feedtwin.comps.regulator.CurveRegulator.outlet_setpoint	(		self,
		float	mdot,
		FlowConditions	flow )

The pressure this regulator is trying to hold right now [Pa].

Reimplemented from feedtwin.comps.regulator.Regulator.

Definition at line 659 of file regulator.py.

References feedtwin.comps.regulator.Regulator.commanded_setpoint(), feedtwin.comps.base.HydraulicComponent.instance, p, feedtwin.comps.base.HydraulicComponent.p, and feedtwin.comps.regulator.Regulator.supply_effect().

---

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

• lib/feedtwin/feedtwin/comps/regulator.py