propulsion_cycle

adh.wbs.propulsion.propulsion_cycle

Classes:

• Bleed –

  Bleed output component

• Combustor –

  Combustor component of the engine.

• Compressor –

  Compressor component of the engine.

• Duct –

  Duct component of the engine.

• EngineElement –

  Represents an individual element in the engine cycle.

• Inlet –

  Inlet conditions for the engine.

• Nozzle –

  Nozzle component of the engine.

• PropulsionCycle –

  Represents a complete engine cycle.

• Shaft –

  Shaft component of the engine.

• Splitter –

  Splitter component of the engine.

• Turbine –

  Turbine component of the engine.

Bleed pydantic-model

Bases: EngineElement

Bleed output component

Attributes

bleed_names : Optional[List[str]] Names of the bleed connections associated statics : Optional[bool] If true calculate static properties

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Bleed output component\n\nAttributes\n----------\nbleed_names : Optional[List[str]]\n    Names of the bleed connections associated\nstatics : Optional[bool]\n    If true calculate static properties",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number.",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed connections associated",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Bleed",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• area (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• bleed_names (Optional[list[str]])
• statics (Optional[bool])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• mn (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed connections associated

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number.

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Combustor pydantic-model

Bases: EngineElement

Combustor component of the engine.

Attributes

fuel_type : Optional[str] Type of fuel used. mn : Optional[float] Mach number. dp_qp : Optional[float] Pressure drop ratio.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Combustor component of the engine.\n\nAttributes\n----------\nfuel_type : Optional[str]\n    Type of fuel used.\nmn : Optional[float]\n    Mach number.\ndp_qp : Optional[float]\n    Pressure drop ratio.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Combustor",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• fuel_type (Optional[str])
• mn (Optional[float])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• area (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Compressor pydantic-model

Bases: EngineElement

Compressor component of the engine.

Attributes

mn : Optional[float] Mach number. map_data : Optional[str] Map data for the compressor. bleed_names : Optional[List[str]] Names of the bleed ports. map_extrap : Optional[bool] Flag to indicate if map extrapolation is used. pr_des : Optional[float] Design condition pressure ratio eff_des : Optional[float] Design condition efficiency

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Compressor component of the engine.\n\nAttributes\n----------\nmn : Optional[float]\n    Mach number.\nmap_data : Optional[str]\n    Map data for the compressor.\nbleed_names : Optional[List[str]]\n    Names of the bleed ports.\nmap_extrap : Optional[bool]\n    Flag to indicate if map extrapolation is used.\npr_des : Optional[float]\n    Design condition pressure ratio\neff_des : Optional[float]\n    Design condition efficiency",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number(Input)",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Compressor",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• mn (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• area (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number(Input)

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Duct pydantic-model

Bases: EngineElement

Duct component of the engine.

Attributes

mn : Optional[float] Mach number. dp_qp : Optional[float] Pressure drop ratio.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Duct component of the engine.\n\nAttributes\n----------\nmn : Optional[float]\n    Mach number.\ndp_qp : Optional[float]\n    Pressure drop ratio.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Duct",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• statics (Optional[bool])
• mn (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• area (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

EngineElement pydantic-model

Bases: NodeMetaMixin, BaseModel

Represents an individual element in the engine cycle.

Attributes:

• name (str) –

  The name of the engine element.

• options (dict) –

  The options associated with the engine element.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Represents an individual element in the engine cycle.\n\nAttributes:\n    name (str): The name of the engine element.\n    options (dict, optional): The options associated with the engine element.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "EngineElement",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• statics (Optional[bool])
• mn (Optional[float])
• ram_recovery (Optional[float])
• area (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Inlet pydantic-model

Bases: EngineElement

Inlet conditions for the engine.

Attributes

mn : Optional[float] Mach number. ram_recovery : Optional[float] Ram recovery factor. area : Optional[float] On-design frontal area.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Inlet conditions for the engine.\n\nAttributes\n----------\nmn : Optional[float]\n    Mach number.\nram_recovery : Optional[float]\n    Ram recovery factor.\narea : Optional[float]\n    On-design frontal area.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Inlet",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• mn (Optional[float])
• ram_recovery (Optional[float])
• area (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design Mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Nozzle pydantic-model

Bases: EngineElement

Nozzle component of the engine.

Attributes

nozz_type : Optional[str] Type of nozzle. loss_coef : Optional[str] Loss coefficient. cv : Optional[float] Discharge coefficient.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Nozzle component of the engine.\n\nAttributes\n----------\nnozz_type : Optional[str]\n    Type of nozzle.\nloss_coef : Optional[str]\n    Loss coefficient.\ncv : Optional[float]\n    Discharge coefficient.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Nozzle",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• mn (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• area (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

PropulsionCycle pydantic-model

Bases: NodeMetaMixin, BaseModel

Represents a complete engine cycle.

Attributes:

• name (str) –

  The name of the engine cycle.

• design (bool) –

  Whether the engine cycle is in design mode.

• thermo_method (str) –

  The thermodynamic method used in the engine cycle. Defaults to 'CEA'.

• thermo_data (str) –

  The thermodynamic data used in the engine cycle.

• elements (List[EngineElement]) –

  The list of engine elements in the engine cycle.

• balance_components (List[BalanceComponent]) –

  The list of balance components in the engine cycle.

• global_connections (dict) –

  The global connections in the engine cycle.

• flow_connections (dict) –

  The flow connections in the engine cycle.

• solver_settings (dict) –

  The solver settings for the engine cycle.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "EngineElement": {
      "additionalProperties": true,
      "description": "Represents an individual element in the engine cycle.\n\nAttributes:\n    name (str): The name of the engine element.\n    options (dict, optional): The options associated with the engine element.",
      "properties": {
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "A unique model name.",
          "title": "Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "A brief description of the model.",
          "title": "Description"
        },
        "source_info": {
          "anyOf": [
            {
              "$ref": "#/$defs/SourceInfo"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Source and authorship metadata."
        },
        "uuid": {
          "anyOf": [
            {
              "format": "uuid4",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "A globally unique identifier for the model.",
          "title": "Uuid"
        },
        "type": {
          "description": "The type of engine element this is.",
          "title": "Type",
          "type": "string"
        },
        "options": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "The options associated with the engine element.",
          "title": "Options"
        },
        "statics": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "If true calculate static properties",
          "title": "Statics"
        },
        "mn": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design mach number",
          "title": "Mn"
        },
        "ram_recovery": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Ram recovery factor",
          "title": "Ram Recovery"
        },
        "area": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design frontal area of component(Output)",
          "title": "Area"
        },
        "map_data": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Map data for the compressor",
          "title": "Map Data"
        },
        "map_extrap": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Flag to indicate if map extrapolation is used",
          "title": "Map Extrap"
        },
        "map_interp_method": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Method to use for map interpolation.",
          "title": "Map Interp Method"
        },
        "bleed_names": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Names of the bleed ports",
          "title": "Bleed Names"
        },
        "pr_des": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design pressure ratio(Input)",
          "title": "Pr Des"
        },
        "eff_des": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design efficiency(Input)",
          "title": "Eff Des"
        },
        "s_PR": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design pressure ratio(Output)",
          "title": "S Pr"
        },
        "s_eff": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design efficiency(Output)",
          "title": "S Eff"
        },
        "s_Wc": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design air mass flow rate(Output)",
          "title": "S Wc"
        },
        "s_Nc": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design Nc(Output)",
          "title": "S Nc"
        },
        "frac_W": {
          "anyOf": [
            {
              "items": {
                "type": "number"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
          "title": "Frac W"
        },
        "frac_P": {
          "anyOf": [
            {
              "items": {
                "type": "number"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
          "title": "Frac P"
        },
        "frac_work": {
          "anyOf": [
            {
              "items": {
                "type": "number"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Fraction of work to bleed off(associated with each bleed connection)",
          "title": "Frac Work"
        },
        "bpr": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Bypass ratio",
          "title": "Bpr"
        },
        "mn1": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design mach number for the first flow path(Input)",
          "title": "Mn1"
        },
        "mn2": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design mach number for the second flow path(Input)",
          "title": "Mn2"
        },
        "area1": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design frontal area for the first flow path(Output)",
          "title": "Area1"
        },
        "area2": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design frontal area for the second flow path(Output)",
          "title": "Area2"
        },
        "fuel_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type of fuel used",
          "title": "Fuel Type"
        },
        "dp_qp": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design pressure drop ratio",
          "title": "Dp Qp"
        },
        "FAR": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design fuel-air ratio",
          "title": "Far"
        },
        "Wfuel": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design fuel injection rate",
          "title": "Wfuel"
        },
        "nozz_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type of nozzle",
          "title": "Nozz Type"
        },
        "loss_coef": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Loss coefficient",
          "title": "Loss Coef"
        },
        "cv": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Discharge coefficient",
          "title": "Cv"
        },
        "num_ports": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Number of ports on the shaft",
          "title": "Num Ports"
        },
        "nmech": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Mechanical speed in RPM",
          "title": "Nmech"
        },
        "nmech_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Low or high pressure shaft",
          "title": "Nmech Type"
        },
        "HPX": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Horsepower transfer",
          "title": "Hpx"
        },
        "dPqP": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design pressure drop ratio",
          "title": "Dpqp"
        },
        "Q_dot": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "On-design heat flow rate into (positive) or out of (negative) the air",
          "title": "Q Dot"
        }
      },
      "required": [
        "type"
      ],
      "title": "EngineElement",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Represents a complete engine cycle.\n\nAttributes:\n    name (str): The name of the engine cycle.\n    design (bool): Whether the engine cycle is in design mode.\n    thermo_method (str, optional): The thermodynamic method used in the engine cycle. Defaults to 'CEA'.\n    thermo_data (str, optional): The thermodynamic data used in the engine cycle.\n    elements (List[EngineElement]): The list of engine elements in the engine cycle.\n    balance_components (List[BalanceComponent], optional): The list of balance components in the engine cycle.\n    global_connections (dict, optional): The global connections in the engine cycle.\n    flow_connections (dict, optional): The flow connections in the engine cycle.\n    solver_settings (dict, optional): The solver settings for the engine cycle.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "elements": {
      "description": "The list of engine elements in the engine cycle.",
      "items": {
        "$ref": "#/$defs/EngineElement"
      },
      "title": "Elements",
      "type": "array"
    },
    "global_connections": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The global connections in the engine cycle.",
      "title": "Global Connections"
    },
    "flow_connections": {
      "anyOf": [
        {
          "items": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The flow connections in the engine cycle.",
      "title": "Flow Connections"
    }
  },
  "required": [
    "elements"
  ],
  "title": "PropulsionCycle",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• elements (list[SerializeAsAny[EngineElement]])
• global_connections (Optional[list[str]])
• flow_connections (Optional[list[list[str]]])

Validators:

• _coerce_elements

description pydantic-field

description: Optional[str] = None

A brief description of the model.

elements pydantic-field

elements: list[SerializeAsAny[EngineElement]]

The list of engine elements in the engine cycle.

flow_connections pydantic-field

flow_connections: Optional[list[list[str]]] = None

The flow connections in the engine cycle.

global_connections pydantic-field

global_connections: Optional[list[str]] = None

The global connections in the engine cycle.

name pydantic-field

name: Optional[str] = None

A unique model name.

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Shaft pydantic-model

Bases: EngineElement

Shaft component of the engine.

Attributes

num_ports : Optional[int] Number of ports on the shaft. nmech : Optional[float] Mechanical speed in RPM.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Shaft component of the engine.\n\nAttributes\n----------\nnum_ports : Optional[int]\n    Number of ports on the shaft.\nnmech : Optional[float]\n    Mechanical speed in RPM.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Shaft",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• statics (Optional[bool])
• mn (Optional[float])
• ram_recovery (Optional[float])
• area (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Splitter pydantic-model

Bases: EngineElement

Splitter component of the engine.

Attributes

bpr : Optional[float] Bypass ratio. mn1 : Optional[float] Mach number for the first flow path. mn2 : Optional[float] Mach number for the second flow path. area1 : Optional[float] Area for the second flow path. area2 : Optional[float] Area for the second flow path.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Splitter component of the engine.\n\nAttributes\n----------\nbpr : Optional[float]\n    Bypass ratio.\nmn1 : Optional[float]\n    Mach number for the first flow path.\nmn2 : Optional[float]\n    Mach number for the second flow path.\narea1 : Optional[float]\n    Area for the second flow path.\narea2 : Optional[float]\n    Area for the second flow path.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Splitter",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• mn (Optional[float])
• ram_recovery (Optional[float])
• area (Optional[float])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

Turbine pydantic-model

Bases: EngineElement

Turbine component of the engine.

Attributes

mn : Optional[float] Mach number. map_data : Optional[str] Map data for the turbine. bleed_names : Optional[List[str]] Names of the bleed ports. map_extrap : Optional[bool] Flag to indicate if map extrapolation is used. pr_des : Optional[float] Design condition pressure ratio effDes : Optional[float] Design condition efficiency

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Turbine component of the engine.\n\nAttributes\n----------\nmn : Optional[float]\n    Mach number.\nmap_data : Optional[str]\n    Map data for the turbine.\nbleed_names : Optional[List[str]]\n    Names of the bleed ports.\nmap_extrap : Optional[bool]\n    Flag to indicate if map extrapolation is used.\npr_des : Optional[float]\n    Design condition pressure ratio\neffDes : Optional[float]\n    Design condition efficiency",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    },
    "type": {
      "description": "The type of engine element this is.",
      "title": "Type",
      "type": "string"
    },
    "options": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The options associated with the engine element.",
      "title": "Options"
    },
    "statics": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If true calculate static properties",
      "title": "Statics"
    },
    "mn": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number(Input)",
      "title": "Mn"
    },
    "ram_recovery": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ram recovery factor",
      "title": "Ram Recovery"
    },
    "area": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area of component(Output)",
      "title": "Area"
    },
    "map_data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Map data for the compressor",
      "title": "Map Data"
    },
    "map_extrap": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Flag to indicate if map extrapolation is used",
      "title": "Map Extrap"
    },
    "map_interp_method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Method to use for map interpolation.",
      "title": "Map Interp Method"
    },
    "bleed_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Names of the bleed ports",
      "title": "Bleed Names"
    },
    "pr_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Input)",
      "title": "Pr Des"
    },
    "eff_des": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Input)",
      "title": "Eff Des"
    },
    "s_PR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure ratio(Output)",
      "title": "S Pr"
    },
    "s_eff": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design efficiency(Output)",
      "title": "S Eff"
    },
    "s_Wc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design air mass flow rate(Output)",
      "title": "S Wc"
    },
    "s_Nc": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design Nc(Output)",
      "title": "S Nc"
    },
    "frac_W": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming flow to bleed off(associated with each bleed connection)",
      "title": "Frac W"
    },
    "frac_P": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of incoming pressure to bleed off(associated with each bleed connection)",
      "title": "Frac P"
    },
    "frac_work": {
      "anyOf": [
        {
          "items": {
            "type": "number"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fraction of work to bleed off(associated with each bleed connection)",
      "title": "Frac Work"
    },
    "bpr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Bypass ratio",
      "title": "Bpr"
    },
    "mn1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the first flow path(Input)",
      "title": "Mn1"
    },
    "mn2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design mach number for the second flow path(Input)",
      "title": "Mn2"
    },
    "area1": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the first flow path(Output)",
      "title": "Area1"
    },
    "area2": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design frontal area for the second flow path(Output)",
      "title": "Area2"
    },
    "fuel_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of fuel used",
      "title": "Fuel Type"
    },
    "dp_qp": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dp Qp"
    },
    "FAR": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel-air ratio",
      "title": "Far"
    },
    "Wfuel": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design fuel injection rate",
      "title": "Wfuel"
    },
    "nozz_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of nozzle",
      "title": "Nozz Type"
    },
    "loss_coef": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Loss coefficient",
      "title": "Loss Coef"
    },
    "cv": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Discharge coefficient",
      "title": "Cv"
    },
    "num_ports": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of ports on the shaft",
      "title": "Num Ports"
    },
    "nmech": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mechanical speed in RPM",
      "title": "Nmech"
    },
    "nmech_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Low or high pressure shaft",
      "title": "Nmech Type"
    },
    "HPX": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Horsepower transfer",
      "title": "Hpx"
    },
    "dPqP": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design pressure drop ratio",
      "title": "Dpqp"
    },
    "Q_dot": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "On-design heat flow rate into (positive) or out of (negative) the air",
      "title": "Q Dot"
    }
  },
  "required": [
    "type"
  ],
  "title": "Turbine",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])
• type (str)
• options (Optional[dict])
• ram_recovery (Optional[float])
• bpr (Optional[float])
• mn1 (Optional[float])
• mn2 (Optional[float])
• area1 (Optional[float])
• area2 (Optional[float])
• fuel_type (Optional[str])
• dp_qp (Optional[float])
• FAR (Optional[float])
• Wfuel (Optional[float])
• nozz_type (Optional[str])
• loss_coef (Optional[str])
• cv (Optional[float])
• num_ports (Optional[int])
• nmech (Optional[float])
• nmech_type (Optional[str])
• HPX (Optional[float])
• dPqP (Optional[float])
• Q_dot (Optional[float])
• statics (Optional[bool])
• map_data (Optional[str])
• map_extrap (Optional[bool])
• map_interp_method (Optional[str])
• bleed_names (Optional[list[str]])
• pr_des (Optional[float])
• eff_des (Optional[float])
• mn (Optional[float])
• s_PR (Optional[float])
• s_eff (Optional[float])
• s_Wc (Optional[float])
• s_Nc (Optional[float])
• area (Optional[float])
• frac_W (Optional[list[float]])
• frac_P (Optional[list[float]])
• frac_work (Optional[list[float]])

Validators:

• validate_fuel_type → fuel_type

FAR pydantic-field

FAR: Optional[float] = None

On-design fuel-air ratio

HPX pydantic-field

HPX: Optional[float] = None

Horsepower transfer

Q_dot pydantic-field

Q_dot: Optional[float] = None

On-design heat flow rate into (positive) or out of (negative) the air

Wfuel pydantic-field

Wfuel: Optional[float] = None

On-design fuel injection rate

area pydantic-field

area: Optional[float] = None

On-design frontal area of component(Output)

area1 pydantic-field

area1: Optional[float] = None

On-design frontal area for the first flow path(Output)

area2 pydantic-field

area2: Optional[float] = None

On-design frontal area for the second flow path(Output)

bleed_names pydantic-field

bleed_names: Optional[list[str]] = None

Names of the bleed ports

bpr pydantic-field

bpr: Optional[float] = None

Bypass ratio

cv pydantic-field

cv: Optional[float] = None

Discharge coefficient

dPqP pydantic-field

dPqP: Optional[float] = None

On-design pressure drop ratio

description pydantic-field

description: Optional[str] = None

A brief description of the model.

dp_qp pydantic-field

dp_qp: Optional[float] = None

On-design pressure drop ratio

eff_des pydantic-field

eff_des: Optional[float] = None

On-design efficiency(Input)

frac_P pydantic-field

frac_P: Optional[list[float]] = None

Fraction of incoming pressure to bleed off(associated with each bleed connection)

frac_W pydantic-field

frac_W: Optional[list[float]] = None

Fraction of incoming flow to bleed off(associated with each bleed connection)

frac_work pydantic-field

frac_work: Optional[list[float]] = None

Fraction of work to bleed off(associated with each bleed connection)

fuel_type pydantic-field

fuel_type: Optional[str] = None

Type of fuel used

loss_coef pydantic-field

loss_coef: Optional[str] = None

Loss coefficient

map_data pydantic-field

map_data: Optional[str] = None

Map data for the compressor

map_extrap pydantic-field

map_extrap: Optional[bool] = None

Flag to indicate if map extrapolation is used

map_interp_method pydantic-field

map_interp_method: Optional[str] = None

Method to use for map interpolation.

mn pydantic-field

mn: Optional[float] = None

On-design mach number(Input)

mn1 pydantic-field

mn1: Optional[float] = None

On-design mach number for the first flow path(Input)

mn2 pydantic-field

mn2: Optional[float] = None

On-design mach number for the second flow path(Input)

name pydantic-field

name: Optional[str] = None

A unique model name.

nmech pydantic-field

nmech: Optional[float] = None

Mechanical speed in RPM

nmech_type pydantic-field

nmech_type: Optional[str] = None

Low or high pressure shaft

nozz_type pydantic-field

nozz_type: Optional[str] = None

Type of nozzle

num_ports pydantic-field

num_ports: Optional[int] = None

Number of ports on the shaft

options pydantic-field

options: Optional[dict] = None

The options associated with the engine element.

pr_des pydantic-field

pr_des: Optional[float] = None

On-design pressure ratio(Input)

ram_recovery pydantic-field

ram_recovery: Optional[float] = None

Ram recovery factor

s_Nc pydantic-field

s_Nc: Optional[float] = None

On-design Nc(Output)

s_PR pydantic-field

s_PR: Optional[float] = None

On-design pressure ratio(Output)

s_Wc pydantic-field

s_Wc: Optional[float] = None

On-design air mass flow rate(Output)

s_eff pydantic-field

s_eff: Optional[float] = None

On-design efficiency(Output)

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

statics pydantic-field

statics: Optional[bool] = None

If true calculate static properties

type pydantic-field

type: str

The type of engine element this is.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.