Add Analytic Electron-Ion Coupling to CDI

[clevelam]

Background

• This commit adds basic Electron-Ion coupling models to the Common Data Interface (CDI). Thus far, we have only implemented an analytic constant electron-ion coupling model.

Purpose of Pull Request

• Provide initial Electron-Ion coupling models
• Electron-Ion coupling #1420

Description of changes

• Adds EICoupling model to CDI
• This includes the addition of a EICoupling interface class in CDI
• This includes the addition of a derived Analytic_EICoupling interface class that access EICoupling_Model functions
• This includes the addition of an Analytic_EICoupling_Model base class
• This includes the addition of an Analytic_Constant_EICoupling_Model derived class

Status

• Reference:
  • Pre-Merge Code Review
  • CDash Status
• Checks
  • Travis CI checks pass
  • Code coverage does not decrease
  • Valgrind test passes
  • Toss3 checks pass
  • Trinitite checks pass
  • Code reviewed/approved, sufficient DbC checks, testing, documentation

[codecov]

Codecov Report

Merging #586 into develop will increase coverage by <.1%.
The diff coverage is 99.1%.

@@            Coverage Diff            @@
##           develop    #586     +/-   ##
=========================================
+ Coverage     93.7%   93.7%   +<.1%     
=========================================
  Files          377     380      +3     
  Lines        17665   17779    +114     
=========================================
+ Hits         16554   16667    +113     
- Misses        1111    1112      +1

[clevelam]

@kgbudge Will you please look over this PR?

[KineticTheory]

@clevelam Rerunning the the checks on trinitite didn't fix those issues. I'll checkout your PR and attempt to run it manually. Something may have changed on trinitite during this week's DST.

[KineticTheory]

@clevelam As I expected, something has changed on trinitite. I'll consider that a separate issue and won't count the warnings from that machine against this PR.

[KineticTheory]

@clevelam This looks pretty good to me. I've requested a few minor changes, but I don't consider them to be blockers. I would like to get some feedback from @kgbudge, @jhchang-lanl and @warsa. It seems they should have some say in this design as they may need to adopt it.

[berselius]

As you mention this can assume a mixture of ion species underneath - it would be good to have a test case that accepts such a mixture.

[KineticTheory]

@clevelam This looks to be very close to being done. Ping me when you think it is ready.

[KineticTheory]

Last set of changes looks good. All tests pass.