[ArleyAllesCruz]

Description

Motivation

Improve the formation rock thermal properties by accounting for porosity. This PR adds the
attributes needed to describe a porous formation material in .alfacase files; the porosity
model itself is implemented on the ALFAsim side (see the companion PR in alfasim).

How it works

The porosity of a formation material follows Athy's law:

$$ φ(z) = φ_{0} · exp(−b · z) $$

• φ₀: initial_porosity, the porosity at the surface [-]
• b: compaction_coefficient [1/m]
• z: TVD measured from the formation.

ALFAsim uses the porosity of each formation layer to mix the properties of the rock with the
properties of the fluid that fills its pores (pore_fluid_material), producing the effective
density, heat capacity and thermal conductivity of the layer.

Modifications

MaterialDescription: three new optional attributes:

• initial_porosity: Scalar, category dimensionless, default 0.0 [-].
• compaction_coefficient: Scalar, category per length, default 0.0 [1/m].
• pore_fluid_material: str | None, default None. It is the name of a fluid material
  (MaterialType.Fluid) of the case, either a default ALFAsim material (e.g. Brine) or a
  user-defined one. As with other material references in the SDK (material, stagnant_fluid),
  the name is resolved by ALFAsim when the case is loaded, not by the SDK. When None, ALFAsim
  uses the default Brine.

MaterialType: new Formation = "formation" member. It represents a porous rock used in
formation layers and is the only type for which the three attributes above are used.

Units / docs

• Added the per length category to CATEGORIES_USED_ON_DESCRIPTION so its unit list is
  generated and included in the MaterialDescription docs (together with dimensionless).

Generated files

• schema.py: new attributes and 'formation' in the material_type enum.
• MaterialDescription.txt and list_of_unit_for_per_length.txt.
• The matching regression files under tests/alfacase/.

Tests

• filled_case_descriptions.MATERIAL_DESCRIPTION now sets the new attributes to non-default
  values (initial_porosity=0.3, compaction_coefficient=0.0005 1/m, pore_fluid_material="Brine"),
  so the alfacase round-trip tests actually cover them. Since this fixture is shared with
  alfasim, tests there that use it need Brine in their material list (done in the
  companion PR).
• test_material_description_as_dict updated with the new attributes.

Related Issue(s)

ASIM-6913 (originally ASIM-6798, which was closed by accident).

[sonarqubecloud]

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

[BeneBr]

I believe that you need to rebase with master to update the pip requirements.txt to get the new pinned version of cog lib.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud