Rebuild Parameter data structures on current I/O (#71) · Issues · dorie / dorie

Rebuild Parameter data structures on current I/O

Description

As a first step, the data structures for Parameters and Parameterizations will be rebuilt without changes to the current data I/O and parameter input.

Proposal

Add class FlowParameters, storing parameterization information for each grid entity
Add class interface RichardsParameters
Add class MualemVanGenuchtenParameters
Use strong types internally (only)
Adapt local operators
Adapt VTK adaptors

For using the current I/O, we need to

Use MualemVanGenuchten with NearestNeighborInterpolator to read in the data from the file
Then translate to the new data structures and destroy MualemVanGenuchten.

New class structure

How to test the implementation?

Load data from old to new structure. Then verify that functions return the same values at all grid cells.

Related issues

See #63 (closed).

### Description
As a first step, the data structures for Parameters and Parameterizations will be rebuilt without changes to the current data I/O and parameter input.

### Proposal
* Add class `FlowParameters`, storing parameterization information for each grid entity
* Add class interface `RichardsParameters`
* Add class `MualemVanGenuchtenParameters`
* Use strong types internally (only)
* Adapt local operators
* Adapt VTK adaptors

For using the current I/O, we need to
* Use `MualemVanGenuchten` with `NearestNeighborInterpolator` to read in the data from the file
* Then translate to the new data structures and destroy `MualemVanGenuchten`.

### New class structure

```plantuml

FlowParameters "1 per medium" *-- RichardsParameterization
FlowParameters "1 per cell" *-- Scaling
RichardsParameterization <|-- MualemVanGenuchtenParameterization
RichardsParameterization <|-- BrooksCoreyParameterization

class FlowParameters {
  - _param : map<index, pair<shared_ptr<RP>, Scaling>> 
  - _cache : pair<index, pair<shared_ptr<RP>, Scaling>>
  - _gv : LevelGridView
  - _mapper : MCMGMapper<LevelGridView>
  - _config: ParameterTree
__ Caching __
  + bind (Entity)
  + cache () : pair<index, pair<shared_ptr<RP>, Scaling>>
  - verify_cache ()
__ Parameterization functions __
  + conductivity_f () : function<RF(RF)>
  + saturation_f () : function<RF(RF)>
  + water_content_f () : function<RF(RF)>
  + matric_head_f () : function<RF(RF)>
}

note top of FlowParameters
  Class communicating with the LocalOperator
  and all other DUNE and DORiE classes and functions.
end note

class Scaling {
  + head_scale : double
  + cond_scale :double
  + por_scale : double
}

abstract class RichardsParameterization {
  # _theta_r : ResidualWaterContent
  # _theta_s : SaturatedWaterContent
  # _k0 : SaturatedConductivity
__
  + water_content_f () : function<WaterContent(Saturation)>
..
  + {abstract} saturation_f () : function<Saturation(MatricHead)>
  + {abstract} conductivity_f () : function<Conductivity(Saturation)>
..
  + {abstract} parameters () : map<string, double&>
}

note top of RichardsParameterization
  Abstract interface for parameterizations.
  Contains common values and functions.
end note

class MualemVanGenuchtenParameterization {
  - _alpha : Alpha
  - _n : N
  - _tau : Tortuosity
__
  + saturation_f () : function<Saturation(MatricHead)>
  + conductivity_f () : function<Conductivity(Saturation)>
  ..
  + parameters () : map<string, double&>
}

class BrooksCoreyParameterization {
  - _h0 : AirEntryValue
  - _lambda : PoreSizeDistribution
  - _tau : Tortuosity
__
  + saturation_f () : function<Saturation(MatricHead)>
  + conductivity_f () : function<Conductivity(Saturation)>
  ..
  + parameters () : map<string, double&>
}

```

### How to test the implementation?
Load data from old to new structure. Then verify that functions return the same values at all grid cells.

### Related issues
See #63.

Edited Jul 26, 2018 by Lukas Riedel

Discussion
Designs

The one place for your designs

To enable design management, you'll need to meet the requirements. If you need help, reach out to our support team for assistance.