# paths./v2015/api/componentranking/blackoilstream.post.summary
Calculates relative erosion and relative criticality for a set of components (Line object) and a single
flow condition specified through a BlackOilStream object and a ParticleStream object.

# paths./v2015/api/componentranking/blackoilstream.post.description
REQUEST SCHEMA: LineBlackOilStream

Consult the examples and sub-schemas for details on how the various components are defined.

# paths./v2015/api/componentranking/blackoilstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/componentranking/basicstream.post.summary
Calculates relative erosion and relative criticality for a set of components (Line object) and a single
flow condition specified through a BasicStream object and a ParticleStream object.

# paths./v2015/api/componentranking/basicstream.post.description
REQUEST SCHEMA: LineBasicStream

Consult the examples and sub-schemas for details on how the various components are defined.

# paths./v2015/api/componentranking/basicstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/erosion/single/blackoilstream.post.summary
Calculates erosion in mm/ton sand and mm/year for a set of components (Line object) and a single flow
condition. Mixture velocity is also returned.

# paths./v2015/api/erosion/single/blackoilstream.post.description
REQUEST SCHEMA: LineBlackOilStream

Consult the examples and sub-schemas for details on how to specify input.

# paths./v2015/api/erosion/single/blackoilstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/erosion/single/basicstream.post.summary
Calculates erosion in mm/ton sand and mm/year for a set of components (Line object) and a single flow
condition. Mixture velocity is also returned.

# paths./v2015/api/erosion/single/basicstream.post.description
REQUEST SCHEMA: LineBasicStream

Consult the examples and sub-schemas for details on how to specify input.

# paths./v2015/api/erosion/single/basicstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/erosion/timeseries/blackoilstream.post.summary
Calculates erosion in mm/ton sand and mm/year for a set of components (Line object) and a time series of flow
conditions.

# paths./v2015/api/erosion/timeseries/blackoilstream.post.description
REQUEST SCHEMA: LineBlackOilStreamTimeSeries

Consult the examples and sub-schemas for details on how the various components are defined.

# paths./v2015/api/erosion/timeseries/blackoilstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/erosion/timeseries/basicstream.post.summary
Calculates erosion in mm/ton sand and mm/year for a set of components (Line object) and a single flow
condition. Mixture velocity is also returned.

# paths./v2015/api/erosion/timeseries/basicstream.post.description
REQUEST SCHEMA: LineBasicStreamTimeSeries

Consult the examples and sub-schemas for details on how the various components are defined.

# paths./v2015/api/erosion/timeseries/basicstream.post.responses.400.description
Invalid or insufficient input. This includes valid input that is outside the model ranges.

# paths./v2015/api/PredefinedErosiveAgent.get.summary
Provides access to default (RP-O501) density and reduction factor for the erosive agents Quartz, Barite and
Calcite.

# paths./v2015/api/PredefinedErosiveAgent/{erosiveAgentName}.get.summary
Provides access to default (RP-O501) density and reduction factor for a specific predefined erosive agent
as specified by name 'erosiveAgentName'.

# paths./v2015/api/PredefinedTargetMaterial.get.summary
Provides access to default (RP-O501) coefficients K / n and density for all predefined target materials.

# paths./v2015/api/PredefinedTargetMaterial/{targetMaterialName}.get.summary
Provides access to default (RP-O501) coefficients K / n and density for a specific predefined target
material as specified by name 'TargetMaterialName'.

# components.schemas.BlackOilStream.properties.temperatureStd.description
Temperature at standard (reference) condition: [deg C]

# components.schemas.BlackOilStream.properties.pressureStd.description
Pressure at standard (reference) condition: [Bar abs]

# components.schemas.BlackOilStream.properties.gasVolumetricRateStd.description
Gas rate at standard conditions: [m3/day]

# components.schemas.BlackOilStream.properties.oilVolumetricRateStd.description
Oil rate at standard conditions: [m3/day]

# components.schemas.BlackOilStream.properties.waterVolumetricRateStd.description
Water rate at standard conditions: [m3/day]

# components.schemas.BlackOilStream.description
Defines a single 'snapshot' of a fluid stream according to the simplified "Black oil" equation of state.
"Black oil" assumes no flashing or absorption, meaning the gas fraction will behave as an ideal gas, and that
the oil and water phases retain their properties (density/viscosity) regardless of pressure or temperature.
Flow rates are given with reference to a standard condition, for which pressure and temperature are known, i.e.
a volumetric gas flow rate in Sm3/d assumes that the gas density is equal to that of the reference condition
given by PressureStd and TemperatureStd.
            
Mixture density and mixture viscosity are calculated based on the volume weighted fractions of gas. oil and
water, and these are used as inputs to the erosion calculations.

# components.schemas.ErosiveAgent.properties.name.description
Name of predefined erosive agent, or custom name (optional).

# components.schemas.ErosiveAgent.properties.reductionFactor.description
ReductionFactor [-] Correction factor enabling adjustment of the erosive response based on geometric properties
of the erosive agents. For example, proppants would typically be modelled with ReductionFactor > 1.
A value of 1.0 corresponds to standard RP-O501 models.

# components.schemas.ErosiveAgent.description
Describes the erosive agent present in a fluid stream.

To use predefined erosive agent properties (see separate endpoint), specify the name of the predefined
erosive agent. In this case, the values of Density and ReductionFactor will be ignored,
and the corresponding predefined erosive agent values will be applied.
If Name does not correspond to a predefined erosive agent, the values of Density, and ReductionFactor must be
specified.

# components.schemas.ParticleStream.properties.particleDiameter.description
Representative particle diameter. Typically set to d50 for the particle size distribution: [microns]

# components.schemas.ParticleStream.description
Defines the particle content in a fluid stream.

# components.schemas.TargetMaterial.properties.name.description
Name of predefined target material, or custom name (optional).

# components.schemas.TargetMaterial.properties.k.description
Constant of proportionality in RP-O501 response equation

# components.schemas.TargetMaterial.properties.n.description
Velocity exponent in RP-O501 response equation

# components.schemas.TargetMaterial.description
To use predefined target material properties (see separate endpoint), specify the name of the predefined
target material. In this case, the values of AngleDependencyOption, Density, K and N will be ignored,
and the corresponding predefined material values will be applied.
If Name does not correspond to a predefined target material, the values of AngleDependencyOption Density,
K and N must be specified.

# components.schemas.Bend.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.Bend.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.Bend.properties.radiusOfCurvature.description
Radius of curvature for the pipe, expressed in number of inner diameters [-]

# components.schemas.Tee.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.Tee.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.Reducer.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.Reducer.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.Reducer.properties.projectedAngleInDegrees.description
Angle between the pipe axis and the surface of the contracting part of the pipe [deg]

# components.schemas.ErProbe.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.ErProbe.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.ErProbe.properties.projectedAngleInDegrees.description
Angle between the pipe axis and surface of the probe elements [deg]

# components.schemas.ErProbe.description
Erosion probe (electrical resistivity probe) geometry model definition.

# components.schemas.SmoothPipe.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.SmoothPipe.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.WeldedJointUpstream.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.WeldedJointUpstream.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.WeldedJointUpstream.properties.projectedAngleInDegrees.description
Angle between the pipe axis and flow-facing surface of the weld [deg]

# components.schemas.WeldedJointUpstream.description
Welded joint (flow-facing side) geometry model definition.

# components.schemas.WeldedJointDownstream.properties.geometryFactor.description
Correction factor applied to results in order to account for isometric effects (swirl) [-]

# components.schemas.WeldedJointDownstream.properties.erosionAllowance.description
Erosion allowance for component. Used for calculation of relative criticality [mm]

# components.schemas.WeldedJointDownstream.properties.weldHeight.description
Height of weld as measured from the pipe wall [mm]

# components.schemas.WeldedJointDownstream.description
Welded joint (downstream side) geometry model definition.

# components.schemas.ComponentsWrapper.description
Contains definition of all components on the line. At least one of the arrays containing at least one component,
has to be specified.

# components.schemas.Line.description
Contains the Line definition, i.e. the virtual pipe containing a group of components for which erosion
is to be calculated.

# components.schemas.ComponentRanking.description
Relative erosion and relative criticality for a line of components.

# components.schemas.BasicStream.properties.density.description
Representative mixture density of all phases: [kg/m3]

# components.schemas.BasicStream.properties.viscosity.description
Representative mixture viscosity of all phases: [Pas]

# components.schemas.BasicStream.properties.volumetricRate.description
Sum of volumetric flow rate for all phases: [m3/s]

# components.schemas.BasicStream.description
Defines a single 'snapshot' of a fluid stream with direct specification of fluid properties and flow rate.
Note that rates are given as m3/s rather than m3/day.

# components.schemas.ComponentResult.properties.fluidVelocity.description
Mixture velocity applied in erosion model

# components.schemas.ComponentResult.description
Calculation results for a single component.

# components.schemas.BlackOilStreamTimeSeries.properties.temperatureStd.description
Temperature at standard (reference) condition: [deg C]

# components.schemas.BlackOilStreamTimeSeries.properties.pressureStd.description
Pressure at standard (reference) condition: [Bar abs]

# components.schemas.BlackOilStreamTimeSeries.properties.timeSeries.description
Array of timestamps. Several valid formats apply, e.g. "08/18/2018 07:22:16", "8/2018", "2018-08-18T07:22:16.0000000-07:00".
Make sure that all timestamps are arranged in chronological order, as this is required to calculate accumulated erosion.

# components.schemas.BlackOilStreamTimeSeries.properties.gasVolumetricRateStd.description
Array of gas rates at standard conditions: [m3/day]

# components.schemas.BlackOilStreamTimeSeries.properties.oilVolumetricRateStd.description
Array of oil rates at standard conditions: [m3/day]

# components.schemas.BlackOilStreamTimeSeries.properties.waterVolumetricRateStd.description
Array of water rates at standard conditions: [m3/day]

# components.schemas.BlackOilStreamTimeSeries.description
Similar to the BlackOilStream specification, except that pressure, temperature and flow rates are given as time
series rather than a single set of values, enabling more efficient processing of an entire production history.

The fluid stream is defined according to the simplified "Black oil" equation of state.
"Black oil" assumes no flashing or absorption, meaning the gas fraction will behave as an ideal gas, and that
the oil and water phases retain their properties (density/viscosity) regardless of pressure or temperature.
Flow rates are given with reference to a standard condition, for which pressure and temperature are known, i.e.
a volumetric gas flow rate in Sm3/d assumes that the gas density is equal to that of the reference condition
given by PressureStd and TemperatureStd.
            
Mixture density and mixture viscosity are calculated based on the volume weighted fractions of gas. oil and
water, and these are used as inputs to the erosion calculations.
            
Note that the number of data sets, i.e. the length of the pressure, temperature, flow rate and time series
arrays must match each other and those of the ParticleStreamTimeSeries object.

# components.schemas.ParticleStreamTimeSeries.properties.particleDiameter.description
Representative particle diameter. Typically set to d50 for the particle size distribution: [microns]

# components.schemas.ParticleStreamTimeSeries.properties.particleMassFlowRates.description
Array of particle mass flow rates: [g/s]

# components.schemas.ParticleStreamTimeSeries.properties.timeSeries.description
Array of timestamps. Several valid formats apply, e.g. "08/18/2018 07:22:16", "8/2018", "2018-08-18T07:22:16.0000000-07:00".
Make sure that all timestamps are arranged in chronological order, as this is required to calculate accumulated erosion.

# components.schemas.ParticleStreamTimeSeries.description
Similar to the ParticleStream specification, except that particle mass flow rate is given as time series rather
than a single set of values.
            
Please note that the number of data sets, i.e. the length of the ParticleMassFlowRates and TimeSeries arrays
must match each other and those of the fluid stream (BasicStreamTimeSeries or BlackOilStreamTimeSeries).

# components.schemas.ComponentResultTimeSeries.properties.fluidVelocity.description
Array of mixture velocities applied in erosion model

# components.schemas.ComponentResultTimeSeries.description
Calculation results for a single component when fluid and particle streams are specified as time series

# components.schemas.BasicStreamTimeSeries.properties.densities.description
Array of representative mixture densities of all phases: [kg/m3]

# components.schemas.BasicStreamTimeSeries.properties.viscosities.description
Array of representative mixture viscosities of all phases: [Pas]

# components.schemas.BasicStreamTimeSeries.properties.timeSeries.description
Array of timestamps. Several valid formats apply, e.g. "08/18/2018 07:22:16", "8/2018", "2018-08-18T07:22:16.0000000-07:00".
Make sure that all timestamps are arranged in chronological order, as this is required to calculate accumulated erosion.

# components.schemas.BasicStreamTimeSeries.description
Similar to the BasicStream specification, except that fluid density, viscosity and flow rate are given as
time series rather than a single set of values.
Note that rates are given as m3/s rather than m3/day.
            
Also note that the number of data sets, i.e. the length of the density, viscosity, flow rate and TimeSeries
arrays must match each other and those of the ParticleStreamTimeSeries object.