Initial Conditions

[jhdark]

Proposed changes

Initial conditions! With this change, users will be able to define an initial condition for their simulation.

The value of the initial condition can be a float, int or callable. Although the callable function cannot be a function of time.

Usage:

vol_subdomain = F.VolumeSubdomain1D(1, borders=[0, 1], material=dummy_mat)
my_species = F.Species("A")

init_cond = F.InitialCondition(
        value=1.0, species=my_species
    )

Types of changes

What types of changes does your code introduce to FESTIM?

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Code refactoring
• Documentation Update (if none of the other choices apply)
• New tests

Checklist

• Black formatted
• Unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4383e52) 99.02% compared to head (a1b3f81) 99.06%.

Additional details and impacted files

@@             Coverage Diff             @@
##           fenicsx     #640      +/-   ##
===========================================
+ Coverage    99.02%   99.06%   +0.03%     
===========================================
  Files           23       24       +1     
  Lines         1030     1070      +40     
===========================================
+ Hits          1020     1060      +40     
  Misses          10       10              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RemDelaporteMathurin]

First round of comments

[RemDelaporteMathurin]

I don't see where it uses InitialCondition.subdomain are you sure that initial values in subdomains is implemented?

[jhdark]

I don't see where it uses InitialCondition.subdomain are you sure that initial values in subdomains is implemented?

Its not supported for the moment, its just in the PR description, I can edit that

[RemDelaporteMathurin]

Just a couple of final remarks then i'm happy to merge this!