Notts Quant Multiply Rule

Version: v3.0.0 Status: Normative (text), Illustrative (diagrams only) Scope: NOTES_QUANT_MULTIPLY rule for setting well quantity multiplier from concentration factor Domain: RULES-NOTTSQM Precedence: Runs during run analysis workflow

---

Statement

The system shall populate a well's quantity multiplier property from its concentration factor value during run analysis.

When the concentration factor is present, the value is copied directly to the quantity multiplier. When the concentration factor is null, the system defaults to 1 to ensure a neutral multiplicative effect on downstream quantity calculations. This is a Nottingham-specific rule supporting custom quantity multiplication in the analytics pipeline.

---

Quick Reference

ID	Core Behavior	Priority	Status
REQ-RULES-NOTTSQM-001	Sets quantity_multiplier from concentration_factor with null-default of 1	HIGH	Draft

Key Integration Points: Run Analysis Engine, Well Data Model (concentration_factor, quantity_multiplier)

Rule Summary

Property	Value
Name	NOTES_QUANT_MULTIPLY
Scope	Well-level
Triggers	During run analysis workflow
Output	Sets quantity_multiplier on well

---

Rule Flowchart (Illustrative)

This diagram illustrates the rule's decision logic. It does not specify implementation details or timing.

---

Definitions

Term	Definition
concentration_factor	A numeric well property containing the concentration factor value; may be null
quantity_multiplier	A numeric well property to be populated by this rule; used in downstream quantity calculations
NOTES_QUANT_MULTIPLY	The system identifier/code for this rule

---

Assumptions

• The rule is executed as part of the run analysis workflow
• Wells being processed have both concentration_factor and quantity_multiplier properties defined in the data model
• The concentration_factor value, when present, is a valid numeric value

---

Requirements

Quantity Multiplier Calculation (REQ-RULES-NOTTSQM-001)

FR-NOTTSQM-001: Set Quantity Multiplier from Concentration Factor

The system shall set the well's quantity_multiplier property from the concentration_factor value when executing the NOTES_QUANT_MULTIPLY rule, using a default value of 1 when concentration_factor is null.

Inputs/Outputs

Direction	Data	Source/Target
Input	concentration_factor	Well property
Output	quantity_multiplier	Well property

Acceptance Criteria

Value Assignment:

• When concentration_factor has a numeric value, set quantity_multiplier to that value
• When concentration_factor is null, set quantity_multiplier to 1
• The value shall be copied directly without transformation when concentration_factor is present

Property Handling:

• Read the source value from the well's concentration_factor property
• Write the computed value to the well's quantity_multiplier property
• The quantity_multiplier value shall be applied to the well during rule analysis execution

Scope and Execution:

• The rule shall operate at well-level scope
• The rule shall execute for wells that have a quantity_multiplier property requiring population

Error Handling

• Null concentration_factor: use default value of 1 (neutral multiplier)

Trace: Source: 3.0.0-Notts Quant Multiply Rule (Rows 1-2) | Jira: BT-3893 (Epic), BT-3899 (Task), BT-3952 (Test) | Tests: [See BT-3952](#test-req-rules-nottsqm-001)

---

Configuration Options

Option	Default	Description	Affects
default_multiplier	1	Value used when concentration_factor is null	REQ-RULES-NOTTSQM-001

---

UI Notes (Illustrative)

No UI-specific details identified in source material. This rule operates within the analytics engine without direct UI interaction.

---

Implementation (Illustrative)

Component	Location
Rule Class	Analyzer/Rules/NotesQuantMultiplyRule.php

---

Traceability Matrix

Requirement	Title	Verification	Implementation	Test Cases	Status
REQ-RULES-NOTTSQM-001	Set Quantity Multiplier from Concentration Factor	Test	NotesQuantMultiplyRule	BT-3952	Draft

---

Notes

• This is a Nottingham-specific rule for custom quantity multiplication
• Rule code in system: NOTES_QUANT_MULTIPLY
• The choice of 1 as the default value ensures that when no concentration factor is specified, the quantity multiplier has a neutral effect (multiplying by 1 preserves the original quantity)
• BT-3899 (Store quantity multiplier) and BT-3952 (Verify the NotesQuantMultiply Rule) are marked as manually tested

---

Acceptance Tests

Test: REQ-RULES-NOTTSQM-001

Back to requirement

Test: Valid concentration factor - copy value

Given: A well with the following properties:
  | Property | Value |
  | concentration_factor | 250 |
  | quantity_multiplier | null |
When: The system executes the NOTES_QUANT_MULTIPLY rule for the well
Then: The quantity_multiplier of the well shall be 250

Test: Null concentration factor - default to 1

Given: A well with the following properties:
  | Property | Value |
  | concentration_factor | null |
  | quantity_multiplier | null |
When: The system executes the NOTES_QUANT_MULTIPLY rule for the well
Then: The quantity_multiplier of the well shall be 1

---

Appendix: Process Artifacts

Completion Checklist

• All requirements are capability-level (describe behavior, not UI)
• Requirement variants consolidated (no requirement explosion)
• UI details in Illustrative sections
• Configuration options are not encoded as requirements
• Acceptance criteria describe behavior, not UI mechanics
• Every requirement has acceptance criteria and source traceability
• Error handling addressed
• Open questions documented with owners assigned
• Consolidations documented in Reviewer Notes with reversibility info
• Module can survive a full UI redesign unchanged
• Refinements folded into acceptance criteria
• Traceability matrix is complete

Reviewer Notes

No Consolidation Required

This domain contains a single requirement (REQ-RULES-NOTTSQM-001) representing a single capability. No consolidation was performed.

Source Verification:

• Source requirement count: 1
• Output requirement count: 1
• All test scenarios preserved as acceptance criteria

Reversibility: Source requirements preserved 1:1.

• Source: output/srs/rules/rule-notts-quant-multiply.md