GEOS-DEV / GEOS-DEV/GEOS

CompositionalMultiPhaseFluid documentation

Open
#3,392 1 comment 0 reactions 1 assignee View on GitHub

@dkachuma is already working on this.

Since May 14, 2025.

type: documentation type: new
Dominant language
C++
Stars
287
Forks
109
Avg merge
4d 41m
Merged PRs (30d)
5

Description

What needs to be documented?
CompositionalMultiPhaseFluid object

What sort of documentation would help?
UserGuide and DeveloperGuide.

What are the deficiencies of the existing documentation?
Existing documentation needs to be updated.

Additional notes or context
I have been using GEOS for my own interest of simulating compositional fluid models. Recently, I noticed that GEOS supports "new" CompositionalMultiPhaseFluid, with the implementation of LBC viscosity model. However, I referenced to the documentation for the input file of this object, and it seems that it does not match the code implementation of this "new" CompositionalMultiPhaseFluid.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.