# ProspectAnalysisInputDto

Schema: #/components/schemas/ProspectAnalysisInputDto

Method: SCHEMA
Version: 1
Security: bearer, appkey

## Schema fields:

  - `calculationSettings` (object)
    A data transfer object (DTO) representing the Monte Carlo simulation settings.

  - `calculationSettings.calculationMethod` (string)
    Calculation method: probabilistic or deterministic.
    Enum: "Stochastic", "Deterministic"

  - `calculationSettings.initialSeed` (integer)
    The initial seed for the random number generator.
Running a second calculation with the same initial seed causes the calculator to select the same numbers again.

  - `calculationSettings.sampleSize` (integer)
    How many trials to compute.

  - `calculationSettings.useInitialSeed` (boolean)
    Controls the use of the initial seed value.

  - `calculationSettings.resourceLimits` (object)
    Resource limits

  - `calculationSettings.resourceLimits.minimumVolumeHcType` (string)
    Hydrocarbon case type for resource limits.
    Enum: "Oil", "NonAssociatedGas", "AssociatedGas", "Condensate", "OilEquivalent"

  - `calculationSettings.resourceLimits.minimumVolume` (number)
    Minimum volume

  - `calculationSettings.resourceLimits.screeningThresholdVolume` (number)
    Defines a minimum economic recoverable volume.
The screening threshold estimates a probability for a discovery above the screening threshold.

  - `calculationSettings.resourceLimits.wellPathDepth` (number)
    Depth of the well path

  - `enrolledAnalysisIds` (array)
    Enrolled segment analysis IDs

  - `dbCompatiblePlayRiskDependencyGroups` (array)
    Play risk dependency groups

  - `dbCompatiblePlayRiskDependencyGroups.name` (string)
    Label for the dependency group.

  - `dbCompatiblePlayRiskDependencyGroups.isMaxCorrelation` (boolean)
    Determines the type of dependency - Max correlation (true) or Shared probability (false).

  - `dbCompatiblePlayRiskDependencyGroups.sharedProbability` (number)
    Shared probability for risk dependency, lower value indicates higher dependency. Null when max correlation is used.

  - `dbCompatiblePlayRiskDependencyGroups.riskTypeId` (integer)
    ID of the risk type identified for this group.

  - `dbCompatiblePlayRiskDependencyGroups.description` (string)
    Dependency group description.

  - `dbCompatiblePlayRiskDependencyGroups.members` (array)
    Plays that make up this dependency group.

  - `dbCompatiblePlayRiskDependencyGroups.members.id` (integer)
    The ID of the play that is a play risk dependency group member.

  - `dbCompatiblePlayRiskDependencyGroups.memberGroups` (array)
    Play risk dependency groups can be members of other play risk dependency groups.

  - `conditionalRiskDependencyGroups` (array)
    Conditional (segment) risk dependency groups

  - `conditionalRiskDependencyGroups.name` (string)
    The name of the dependency group, chosen by the user.

  - `conditionalRiskDependencyGroups.parameterName` (string)
    The name of the risk parameter (risk factor) displaying a dependency.

  - `conditionalRiskDependencyGroups.probability` (number)
    The shared probability of the risk dependency.
Value must be in the range [0, 1].
0 means maximum shared probability.
Null when max correlation is used (Slb.Spar.WebApi.DTOs.v1.Analysis.ProspectAnalysis.DependencyGroupDto.IsMaxCorrelation is true).

  - `conditionalRiskDependencyGroups.isMaxCorrelation` (boolean)
    Determines the type of dependency - Max correlation (true) or Shared probability (false).

  - `conditionalRiskDependencyGroups.isForPlayRiskDependency` (boolean)
    Determines the source of dependency - play risk dependency (true) or conditional (i.e. segment) risk dependency (false).

  - `conditionalRiskDependencyGroups.members` (array)
    The members of the dependency group (representing risk factors).

  - `conditionalRiskDependencyGroups.members.name` (string)
    The name of the parent segment of the enrolled analysis,
the name of the play if this object is a member of a play dependency group,
or the name of the parent dependency group if this member is itself representing a group.

  - `conditionalRiskDependencyGroups.members.parameterName` (string)
    The risk parameter name.

  - `conditionalRiskDependencyGroups.members.isForPlayRiskDependency` (boolean)
    Determines the source of dependency - play risk dependency (true) or conditional (i.e. segment) risk dependency (false).

  - `conditionalRiskDependencyGroups.members.isGroup` (boolean)
    Indicates whether this member is itself a group; if true, there must be a DependencyGroup with the same name.

  - `resourceLimits` (object)
    A data transfer object (DTO) representing resource limits for aggregation.

  - `resourceLimits.useScreeningThreshold` (boolean)
    Indicate if the above screening threshold resource limit was set.

  - `resourceLimits.hcType` (string)
    The hydrocarbon type list [Oil, NonAssoc.Gas, Assoc.Gas, Condensate, or Total Resources] defines
the fluid basis for defining a success case's minimum recoverable volume.

  - `resourceLimits.volume` (number)
    Defines a minimum economic recoverable volume.
The screening threshold estimates a probability for a discovery above the screening threshold.

  - `correlations` (array)
    Parameters whose values are correlated between segments

  - `correlations.correlationFactor` (number, required)
    The strength of the correlation.

  - `correlations.dependentParameter` (string, required)
    The name of the dependent parameter.

  - `correlations.independentParameter` (string, required)
    The name of the independent parameter.

  - `correlations.dependentSegmentId` (integer)
    The id of the segment which the dependent parameter belongs to.

  - `correlations.independentSegmentId` (integer)
    The id of the segment which the independent parameter belongs to.

  - `correlations.dependentSegmentName` (string)
    The name of the segment which the dependent parameter belongs to.

  - `correlations.independentSegmentName` (string)
    The name of the segment which the independent parameter belongs to.

  - `correlations.dependentAnalysisId` (integer)
    The id of the analysis which the dependent parameter belongs to.

  - `correlations.independentAnalysisId` (integer)
    The id of the analysis which the independent parameter belongs to.

