From 26d4aba00397fa6e1811d7e521418a55bcacd8e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ole=20Petter=20L=C3=B8d=C3=B8en?= Date: Fri, 14 Jun 2024 12:21:26 +0200 Subject: [PATCH] docs: clean up documentation around compressor modelling including adding some missing keywords (#528) ECALC-1235 ECALC-1236 ECALC-1237 ECALC-1238 ECALC-1239 --- .../compressor_charts/index.md | 26 +++++---- .../single_speed_compressor_train_model.md | 9 +++- .../about/modelling/setup/models/index.md | 2 +- .../references/keywords/CALCULATE_MAX_RATE.md | 53 +++++++++++++++++++ .../about/references/keywords/CHART_TYPE.md | 33 ++++++++++++ .../references/keywords/COMPRESSOR_CHART.md | 36 +++++++++++++ .../references/keywords/COMPRESSOR_TRAIN.md | 25 +++++++++ .../keywords/COMPRESSOR_TRAIN_MODEL.md | 2 +- .../references/keywords/CONTROL_MARGIN.md | 3 +- .../keywords/CONTROL_MARGIN_UNIT.md | 3 +- .../about/references/keywords/DESIGN_HEAD.md | 40 ++++++++++++++ .../about/references/keywords/DESIGN_RATE.md | 40 ++++++++++++++ .../references/keywords/INLET_TEMPERATURE.md | 5 +- .../keywords/POLYTROPIC_EFFICIENCY.md | 35 ++++++++++++ .../references/keywords/PRESSURE_CONTROL.md | 2 +- .../keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md | 36 +++++++++++++ docs/docs/about/references/keywords/STAGES.md | 41 +++++++++++--- 17 files changed, 366 insertions(+), 25 deletions(-) create mode 100644 docs/docs/about/references/keywords/CALCULATE_MAX_RATE.md create mode 100644 docs/docs/about/references/keywords/CHART_TYPE.md create mode 100644 docs/docs/about/references/keywords/COMPRESSOR_CHART.md create mode 100644 docs/docs/about/references/keywords/COMPRESSOR_TRAIN.md create mode 100644 docs/docs/about/references/keywords/DESIGN_HEAD.md create mode 100644 docs/docs/about/references/keywords/DESIGN_RATE.md create mode 100644 docs/docs/about/references/keywords/POLYTROPIC_EFFICIENCY.md create mode 100644 docs/docs/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md index 8d5d728f15..75f076a55f 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md @@ -1,7 +1,7 @@ --- -title: Compressor charts +title: Compressor chart sidebar_position: 2 -description: Introduction into compressor charts +description: Introduction to compressor chart --- # Compressor chart @@ -157,15 +157,18 @@ Unified generic compressor chart: ![](generic_unified_compressor_chart.png) -The compressor chart is created by scaling the unified generic compressor chart in the figure above with a design actual -rate and head. Note that the rate is here in the units *am3/hr* which is NOT EQUAL to *Sm3/hr*. -The units *am3/hr* refers to the volumetric rate at inlet conditions (inlet pressure and temperature), and it will differ from the inputted standard rates -due to the difference in density. -The design polytropic head is given in either *kJ/kg*, *m* or J/kg, `UNITS`. - -The generic compressor chart is currently accompanied by a fixed polytropic efficiency (polytropic efficiency +The compressor chart is created by scaling the unified generic compressor chart in the figure above with a +[DESIGN_RATE](/about/references/keywords/DESIGN_RATE.md) and a [DESIGN_HEAD](/about/references/keywords/DESIGN_HEAD.md). +The generic compressor chart is currently accompanied by a fixed +[POLYTROPIC_EFFICIENCY](/about/references/keywords/POLYTROPIC_EFFICIENCY.md) (polytropic efficiency variations within the chart may be supported in the future). +The [UNITS](/about/references/keywords/UNITS.md) for the `RATE`, `HEAD` and `EFFICIENCY` must also be defined. Note that +the only rate unit available here is *am3/hr* which is NOT EQUAL to *Sm3/hr*. The units *am3/hr* refers to the +volumetric rate at inlet conditions (inlet pressure and temperature), and it will differ from the inputted standard +rates due to the difference in density. The design polytropic head is given in either *kJ/kg*, *m* or J/kg. + + ### Format ~~~~~~~~yaml MODELS: @@ -226,6 +229,11 @@ The generic chart from input is also based on the unified generic compressor cha However, in this case the design point is not specified when setting up the model, instead it is estimated at run time and is entirely based on the inputted data set. An algorithm is used to set a design point such that all the input data is within the capacity. Even if there is a large spread in the data, all data points will solve. High rate/head data points will just be covered by the curve; whilst low rate points outside the minimum flow point will have recirculation. +The generic compressor chart is currently accompanied by a fixed +[POLYTROPIC_EFFICIENCY](/about/references/keywords/POLYTROPIC_EFFICIENCY.md) (polytropic efficiency +variations within the chart may be supported in the future). + +The [UNITS](/about/references/keywords/UNITS.md) for the `EFFICIENCY` must also be defined. This method has one major potential downside in comparison to the `Generic compressor chart with predefined design point`. As all data points will be covered by the compressor curve, if there is an extremely large or unrealistic head or rate value, the other more "normal" data points will be impacted and will either result in a large head adjustment (via upstream/downstream choking) or it will have a large recirculation rate. This has the potential to skew the entire data set solely due to one unrealistic data point. Thus, if this generic chart is utilised it is important to make sure that unrealistic data is filtered out. diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md index 02d25c0cab..2400489e31 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md @@ -13,10 +13,15 @@ This means that a single speed compressor model needs the following to be define - A polytropic compressor chart for every compressor stage in the compressor train. For single speed trains, eCalc only supports user defined single speed compressor charts. -- A [FLUID MODEL](/about/modelling/setup/models/fluid_model.md). -- A [PRESSURE_CONTROL](/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md). +- A [FLUID_MODEL](/about/references/keywords/FLUID_MODEL.md). +- A [PRESSURE_CONTROL](/about/references/keywords/PRESSURE_CONTROL.md). +The following keywords are optional for a single speed compressor model: +- [MAXIMUM_DISCHARGE_PRESSURE](/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md) +- [POWER_ADJUSTMENT_CONSTANT](/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md) +- [MAXIMUM_POWER](/about/references/keywords/MAXIMUM_POWER.md) +- [CALCULATE_MAX_RATE](/about/references/keywords/CALCULATE_MAX_RATE.md) The model is defined under the main keyword [MODELS](/about/references/keywords/MODELS.md) in the format diff --git a/docs/docs/about/modelling/setup/models/index.md b/docs/docs/about/modelling/setup/models/index.md index 5faa9e31e9..4a731c59c8 100644 --- a/docs/docs/about/modelling/setup/models/index.md +++ b/docs/docs/about/modelling/setup/models/index.md @@ -24,7 +24,7 @@ MODELS: The supported types are: - `FLUID` described in more detail in [Fluid model](/about/modelling/setup/models/fluid_model.md) -- `COMPRESSOR_CHART` +- `COMPRESSOR_CHART` described in more detail in [Compressor chart](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md) - `SINGLE_SPEED_COMPRESSOR_TRAIN` - `SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN` - `VARIABLE_SPEED_COMPRESSOR_TRAIN` diff --git a/docs/docs/about/references/keywords/CALCULATE_MAX_RATE.md b/docs/docs/about/references/keywords/CALCULATE_MAX_RATE.md new file mode 100644 index 0000000000..f2689fe881 --- /dev/null +++ b/docs/docs/about/references/keywords/CALCULATE_MAX_RATE.md @@ -0,0 +1,53 @@ +# CALCULATE_MAX_RATE + +[MODELS](/about/references/keywords/MODELS.md) / +[CALCULATE_MAX_RATE](/about/references/keywords/CALCULATE_MAX_RATE.md) + +## Description + +The keyword [CALCULATE_MAX_RATE](CALCULATE_MAX_RATE) is optional with default value `False`. When set to `True`, the +maximum standard rate the compressor train model can handle, based on the input suction and discharge pressures, will +be calculated and reported in the results. This will be done for all dates according to the requested output frequency. + +Calculation of maximum standard rate is supported for compressor train models of type: +- [SINGLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md) +- [SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md) +- [VARIABLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md) +- [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). + + +:::warning Warning +The CALCULATE_MAX_RATE keyword will in most cases add significantly to the run time of the model. +Only use when needed! +::: + +## Format + +~~~~~~~~yaml +MODELS: + - NAME: + TYPE: SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN + FLUID_MODEL: + COMPRESSOR_TRAIN: + STAGES: + - INLET_TEMPERATURE: + COMPRESSOR_CHART: + - ... and so forth for each stage in the train + CALCULATE_MAX_RATE: + ... +~~~~~~~~ + +## Example + +~~~~~~~~yaml +MODELS: + - NAME: simplified_compressor_model + TYPE: SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN + FLUID_MODEL: fluid_model_1 + COMPRESSOR_TRAIN: + STAGES: + - INLET_TEMPERATURE: 30 + COMPRESSOR_CHART: predefined_variable_speed_compressor_chart + CALCULATE_MAX_RATE: True +~~~~~~~~ + diff --git a/docs/docs/about/references/keywords/CHART_TYPE.md b/docs/docs/about/references/keywords/CHART_TYPE.md new file mode 100644 index 0000000000..65f5ba10a4 --- /dev/null +++ b/docs/docs/about/references/keywords/CHART_TYPE.md @@ -0,0 +1,33 @@ +# CHART_TYPE + +## Description + +`CHART_TYPE` is a required to be specified under the [MODELS](/about/references/keywords/MODELS.md) keyword when +the model is of [TYPE](/about/references/keywords/TYPE.md) `COMPRESSOR_CHART`. + +The `CHART_TYPE` can either be set to: +- SINGLE_SPEED +- VARIABLE_SPEED +- GENERIC_FROM_INPUT +- GENERIC_FROM_DESIGN_POINT + + +## Format + +~~~~yaml +MODELS: + - NAME: + TYPE: COMPRESSOR_CHART + CHART_TYPE: + ... +~~~~ + +## Example + +~~~~yaml +MODELS: + - NAME: compressor_chart_model_reference_name + TYPE: COMPRESSOR_CHART + CHART_TYPE: SINGLE_SPEED + ... +~~~~ \ No newline at end of file diff --git a/docs/docs/about/references/keywords/COMPRESSOR_CHART.md b/docs/docs/about/references/keywords/COMPRESSOR_CHART.md new file mode 100644 index 0000000000..cb399d436c --- /dev/null +++ b/docs/docs/about/references/keywords/COMPRESSOR_CHART.md @@ -0,0 +1,36 @@ +# COMPRESSOR_CHART + +[MODELS](/about/references/keywords/MODELS.md) / +[...] / +[STAGES](/about/references/keywords/STAGES.md) / +[COMPRESSOR_CHART](/about/references/keywords/COMPRESSOR_CHART.md) + + +## Description +This is a keyword used in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) when defining the individual stages of a compressor train. +It is a necessary input parameter which is a reference to a [compressor chart model](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md) defined in [MODELS](/about/references/keywords/MODELS.md). + + +## Format + +~~~~~yaml +MODELS: + - NAME: + ... + COMPRESSOR_TRAIN: + STAGES: + - COMPRESSOR_CHART: + ... +~~~~~ + +## Example + +~~~~~yaml +MODELS: + - NAME: compressor_train + ... + COMPRESSOR_TRAIN: + STAGES: + - COMPRESSOR_CHART: stage1_compressor_chart + ... +~~~~~ diff --git a/docs/docs/about/references/keywords/COMPRESSOR_TRAIN.md b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN.md new file mode 100644 index 0000000000..5fff5df92b --- /dev/null +++ b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN.md @@ -0,0 +1,25 @@ +# COMPRESSOR_TRAIN + +## Description + +This keyword is necessary when defining a compressor model. It relates to defining the actual +[STAGES](/about/references/keywords/STAGES.md) in the compressor model. + +## Format + +~~~~yaml +MODELS: + - NAME: + TYPE: + FLUID_MODEL: + COMPRESSOR_TRAIN: + STAGES: + - INLET_TEMPERATURE: + COMPRESSOR_CHART: + PRESSURE_DROP_AHEAD_OF_STAGE: + - INLET_TEMPERATURE: + COMPRESSOR_CHART: + PRESSURE_DROP_AHEAD_OF_STAGE: + - ... and so forth for each stage in the train + ... +~~~~ diff --git a/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md index 254a353441..feaa5bf3a3 100644 --- a/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md +++ b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md @@ -10,7 +10,7 @@ | Yes | `ENERGY_USAGE_MODEL` | None | ## Description -Reference to an compressor train model defined in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) or +Reference to a compressor train model defined in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) or [MODELS](/about/references/keywords/MODELS.md) used for [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) TYPE [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). diff --git a/docs/docs/about/references/keywords/CONTROL_MARGIN.md b/docs/docs/about/references/keywords/CONTROL_MARGIN.md index c817e72f0f..9cca0a14ca 100644 --- a/docs/docs/about/references/keywords/CONTROL_MARGIN.md +++ b/docs/docs/about/references/keywords/CONTROL_MARGIN.md @@ -2,7 +2,8 @@ [MODELS](/about/references/keywords/MODELS.md) / [...] / -[STAGES](/about/references/keywords/STAGES.md) +[STAGES](/about/references/keywords/STAGES.md) / +[CONTROL_MARGIN](/about/references/keywords/CONTROL_MARGIN.md) ## Description diff --git a/docs/docs/about/references/keywords/CONTROL_MARGIN_UNIT.md b/docs/docs/about/references/keywords/CONTROL_MARGIN_UNIT.md index 4232832408..01d5e8594a 100644 --- a/docs/docs/about/references/keywords/CONTROL_MARGIN_UNIT.md +++ b/docs/docs/about/references/keywords/CONTROL_MARGIN_UNIT.md @@ -2,7 +2,8 @@ [MODELS](/about/references/keywords/MODELS.md) / [...] / -[STAGES](/about/references/keywords/STAGES.md) +[STAGES](/about/references/keywords/STAGES.md) / +[CONTROL_MARGIN_UNIT](/about/references/keywords/CONTROL_MARGIN_UNIT.md) ## Description diff --git a/docs/docs/about/references/keywords/DESIGN_HEAD.md b/docs/docs/about/references/keywords/DESIGN_HEAD.md new file mode 100644 index 0000000000..3b92f7fefd --- /dev/null +++ b/docs/docs/about/references/keywords/DESIGN_HEAD.md @@ -0,0 +1,40 @@ +# DESIGN_HEAD + +## Description + +`DESIGN_HEAD` is required to be specified under the [MODELS](/about/references/keywords/MODELS.md) keyword when +the model is of [TYPE](/about/references/keywords/TYPE.md) `COMPRESSOR_CHART` **and** the [CHART_TYPE](/about/references/keywords/CHART_TYPE.md) +is `GENERIC_FROM_DESIGN_POINT`. For more details see [Generic compressor chart with predefined design point](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md#generic-compressor-chart-with-predefined-design-point) + +## Format + +~~~~yaml +MODELS: + - NAME: + TYPE: COMPRESSOR_CHART + CHART_TYPE: + POLYTROPIC_EFFICIENCY: + DESIGN_RATE: + DESIGN_HEAD: + UNITS: + RATE: + HEAD: + EFFICIENCY: + ... +~~~~ + +## Example + +~~~~yaml +MODELS: + - NAME: generic_from_design_point_compressor_chart + TYPE: COMPRESSOR_CHART + CHART_TYPE: GENERIC_FROM_DESIGN_POINT + POLYTROPIC_EFFICIENCY: 0.75 + DESIGN_RATE: 7000 + DESIGN_HEAD: 50 + UNITS: + RATE: AM3_PER_HOUR + HEAD: KJ_PER_KG + EFFICIENCY: FRACTION +~~~~ \ No newline at end of file diff --git a/docs/docs/about/references/keywords/DESIGN_RATE.md b/docs/docs/about/references/keywords/DESIGN_RATE.md new file mode 100644 index 0000000000..b1a5070fb3 --- /dev/null +++ b/docs/docs/about/references/keywords/DESIGN_RATE.md @@ -0,0 +1,40 @@ +# DESIGN_RATE + +## Description + +`DESIGN_RATE` is required to be specified under the [MODELS](/about/references/keywords/MODELS.md) keyword when +the model is of [TYPE](/about/references/keywords/TYPE.md) `COMPRESSOR_CHART` **and** the [CHART_TYPE](/about/references/keywords/CHART_TYPE.md) +is `GENERIC_FROM_DESIGN_POINT`. For more details see [Generic compressor chart with predefined design point](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md#generic-compressor-chart-with-predefined-design-point) + +## Format + +~~~~yaml +MODELS: + - NAME: + TYPE: COMPRESSOR_CHART + CHART_TYPE: + POLYTROPIC_EFFICIENCY: + DESIGN_RATE: + DESIGN_HEAD: + UNITS: + RATE: + HEAD: + EFFICIENCY: + ... +~~~~ + +## Example + +~~~~yaml +MODELS: + - NAME: generic_from_design_point_compressor_chart + TYPE: COMPRESSOR_CHART + CHART_TYPE: GENERIC_FROM_DESIGN_POINT + POLYTROPIC_EFFICIENCY: 0.75 + DESIGN_RATE: 7000 + DESIGN_HEAD: 50 + UNITS: + RATE: AM3_PER_HOUR + HEAD: KJ_PER_KG + EFFICIENCY: FRACTION +~~~~ \ No newline at end of file diff --git a/docs/docs/about/references/keywords/INLET_TEMPERATURE.md b/docs/docs/about/references/keywords/INLET_TEMPERATURE.md index a16eb9762b..2aba3d5e1e 100644 --- a/docs/docs/about/references/keywords/INLET_TEMPERATURE.md +++ b/docs/docs/about/references/keywords/INLET_TEMPERATURE.md @@ -1,13 +1,14 @@ # INLET_TEMPERATURE -[MODELS](/about/references/keywords/MODELS.md) / [INLET_TEMPERATURE](/about/references/keywords/INLET_TEMPERATURE.md) +[MODELS](/about/references/keywords/MODELS.md) / [...] / [STAGES](/about/references/keywords/STAGES.md) / [INLET_TEMPERATURE](/about/references/keywords/INLET_TEMPERATURE.md) | Required | Child of | Children/Options | |----------|------------------------------------------------|------------------| | Yes | [MODELS](/about/references/keywords/MODELS.md) | None | ## Description -This is a keyword used in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md). It is a necessary input parameter which describes the inlet temperature to a compressor stage. Temperature **must** be given in oC. +This is a keyword used in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) when defining the individual stages of a compressor train. +It is a necessary input parameter which describes the inlet temperature to a compressor stage. Temperature **must** be given in oC. As of now, this is can only be given as a single value. Time-series are not accepted here. diff --git a/docs/docs/about/references/keywords/POLYTROPIC_EFFICIENCY.md b/docs/docs/about/references/keywords/POLYTROPIC_EFFICIENCY.md new file mode 100644 index 0000000000..84b2eb9dc3 --- /dev/null +++ b/docs/docs/about/references/keywords/POLYTROPIC_EFFICIENCY.md @@ -0,0 +1,35 @@ +# POLYTROPIC_EFFICIENCY + +## Description + +`POLYTROPIC_EFFICIENCY` is required to be specified under the [MODELS](/about/references/keywords/MODELS.md) keyword when +the model is of [TYPE](/about/references/keywords/TYPE.md) `COMPRESSOR_CHART` **and** the [CHART_TYPE](/about/references/keywords/CHART_TYPE.md) +is either `GENERIC_FROM_INPUT`or `GENERIC_FROM_DESIGN_POINT`. The polytropic efficiency will be a fixed number for all +rate/head values in the compressor chart. + + +## Format + +~~~~yaml +MODELS: + - NAME: + TYPE: COMPRESSOR_CHART + CHART_TYPE: + POLYTROPIC_EFFICIENCY: + UNITS: + EFFICIENCY: + ... +~~~~ + +## Example + +~~~~yaml +MODELS: + - NAME: compressor_chart_model_reference_name + TYPE: COMPRESSOR_CHART + CHART_TYPE: GENERIC_FROM_INPUT + POLYTROPIC_EFFICIENCY: 0.75 + UNITS: + EFFICIENCY: FRACTION + ... +~~~~ \ No newline at end of file diff --git a/docs/docs/about/references/keywords/PRESSURE_CONTROL.md b/docs/docs/about/references/keywords/PRESSURE_CONTROL.md index 30f27ddb0b..42ba627aca 100644 --- a/docs/docs/about/references/keywords/PRESSURE_CONTROL.md +++ b/docs/docs/about/references/keywords/PRESSURE_CONTROL.md @@ -9,7 +9,7 @@ - INDIVIDUAL_ASV_RATE - COMMON_ASV -Further description on how each pressure control method works can be found in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) +Further description on how each pressure control method works can be found in [Fixed speed pressure control](/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md) ## Format diff --git a/docs/docs/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md b/docs/docs/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md new file mode 100644 index 0000000000..40b5b55500 --- /dev/null +++ b/docs/docs/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md @@ -0,0 +1,36 @@ +# PRESSURE_DROP_AHEAD_OF_STAGE + +[MODELS](/about/references/keywords/MODELS.md) / +[...] / +[STAGES](/about/references/keywords/STAGES.md) / +[PRESSURE_DROP_AHEAD_OF_STAGE](/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md) + +## Description +This is a keyword used in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) when defining the individual stages of a compressor train. +It is an optional input parameter. If defined, the inlet pressure of the stage will be reduced with that value before the actual compression starts. + +As of now, this is can only be given as a single value. Time-series are not accepted here. + +## Format + +~~~~~yaml +MODELS: + - NAME: + ... + COMPRESSOR_TRAIN: + STAGES: + - PRESSURE_DROP_AHEAD_OF_STAGE: + ... +~~~~~ + +## Example + +~~~~~yaml +MODELS: + - NAME: compressor_train + ... + COMPRESSOR_TRAIN: + STAGES: + - PRESSURE_DROP_AHEAD_OF_STAGE: 2.2 #bar + ... +~~~~~ diff --git a/docs/docs/about/references/keywords/STAGES.md b/docs/docs/about/references/keywords/STAGES.md index 8fc63ddfb6..8d83507720 100644 --- a/docs/docs/about/references/keywords/STAGES.md +++ b/docs/docs/about/references/keywords/STAGES.md @@ -2,11 +2,31 @@ [MODELS](/about/references/keywords/MODELS.md) / [...] / -[STREAMS](/about/references/keywords/STREAMS.md) +[STAGES](/about/references/keywords/STAGES.md) ## Description -This keyword is used to define each stage in a compression train model. This is to be defined for all compressor models types. +This keyword is used to define each stage in a compression train model. This is to be defined for all compressor +models types. + +## General usage + +It is required to define the [INLET_TEMPERATURE](/about/references/keywords/INLET_TEMPERATURE.md) and a +[COMPRESSOR_CHART](/about/references/keywords/COMPRESSOR_CHART.md) for all compressor stages. It is also possible to +define a [PRESSURE_DROP_AHEAD_OF_STAGE](/about/references/keywords/PRESSURE_DROP_AHEAD_OF_STAGE.md) for each compressor +stage. + + +## Use in `VARIABLE_SPEED_COMPRESSOR_TRAIN` + +For variable speed compressor stages it is also possible to define a +[CONTROL_MARGIN](/about/references/keywords/CONTROL_MARGIN.md) and a +[CONTROL_MARGIN_UNIT](/about/references/keywords/CONTROL_MARGIN_UNIT.md) + +A compressor stage in a [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) +can also have one or more fluid streams attached to it using the [STREAM](/about/references/keywords/STREAM.md) keyword, +or have an intermediate pressure target attached to itself using the [INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) keyword. + ## Format @@ -19,17 +39,24 @@ MODELS: STAGES: - INLET_TEMPERATURE: COMPRESSOR_CHART: + PRESSURE_DROP_AHEAD_OF_STAGE: .... ~~~~ ## Use in `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` -`STAGES` is a list of all the stages in the compressor train. +A compressor stage in a [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) +can also have one or more fluid streams attached to it using the [STREAM](/about/references/keywords/STREAM.md) keyword, +or have an intermediate pressure target attached to itself using the [INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) keyword. + +:::warning Warning +Note that COMPRESSOR_TRAIN is not used for VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES. +STAGES is a list of all the stages in the compressor train. STREAMS is a list of all the fluid streams going in or out +of the compressor train. +::: -- For each stage, a temperature in Celsius must be defined. It -is assumed that the gas is cooled down to this temperature ahead of the compression at this stage. -- A reference to a -compressor chart needs to be specified for each stage. +- For each stage, a temperature in Celsius must be defined. It is assumed that the gas is cooled down to this temperature ahead of the compression at this stage. +- A reference to a compressor chart needs to be specified for each stage. - For the first stage, it is required to have **at least** one stream of INGOING type. In addition, `INTERSTAGE_CONTROL_PRESSURE` cannot be used on the first stage. - Stages 2, ..., N may have a stream defined and it may be in- or outgoing. If an ingoing stream is defined, this stream will be mixed with the outlet stream of the previous stage, obtaining a composition for the mixed fluid based on the