GEOS-DEV / GEOS-DEV/GEOS

Changing some class/catalog names for coupled simulations

Open
#2,003 2 comments 1 reaction 1 assignee View on GitHub

@francoishamon is already working on this.

Since Aug 11, 2022.

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

Description

Describe the issue
Following up on this comment from @klevzoff, I post this issue to know if there is any objection to changing some of our catalog names and class names to have more consistent xml files in the coupled simulations.

Proposed cleanup
Changes in catalog names (following Sergey's suggestion below):

  • CompositionalMultiphaseFVM -> MultiphaseFlowFVM
  • CompositionalMultiphaseHybridFVM -> MultiphaseFlowMimetic
  • CompositionalMultiphaseWell -> MultiphaseWell

which will be consistent with MultiphasePoromechanics in coupled simulations. Class names would be changed accordingly.

Change in attribute names:

  • solidSolverName -> mechanicsSolverName

in the coupled simulations (as discussed during the dev meeting)

Changes in class names (don't appear in the xml, but still):

  • MultiphasePoromechanicsSolver -> MultiphasePoromechanics
  • SinglePhasePoromechanicsSolver -> SinglePhasePoromechanics
  • SinglePhasePoromechanicsSolverEmbeddedFractures -> SinglePhasePoromechanicsEmbeddedFractures
  • FlowProppantTransportSolver -> FlowProppantTransport
  • HydrofractureSolver -> Hydrofracture
  • LagrangianContactSolver -> LagrangianContact

to have consistent class names between single-physics and multiphysics solvers.

I am open to better naming suggestions of course.

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.