InitialConditionFromXDMF class

[RemDelaporteMathurin]

Currently we have the InitialCondition class that can be used for initialising fields with mathematical expressions or XDMF files.

From an mathematical expression:

my_ic = F.InitialCondition(value=F.x**2 + F.y**2, field=0)

From a XDMFfile:

my_ic = F.InitialCondition(
    value="ic_file.xdmf",
    label="mobile",
    time_step=-1,
    field=0
)

We then look check if value is a string and if it ends by .xdmf and initialise fields accordingly:

FESTIM/festim/concentration/concentration.py

Lines 43 to 47 in 31864c8

	def get_comp(self, V, value, label=None, time_step=None):
	if type(value) == str and value.endswith(".xdmf"):
	comp = Function(V)
	with XDMFFile(value) as f:
	f.read_checkpoint(comp, label, time_step)

FESTIM/festim/temperature/temperature_solver.py

Lines 114 to 122 in 31864c8

	if self.transient and self.initial_condition:
	if isinstance(self.initial_condition.value, str):
	if self.initial_condition.value.endswith(".xdmf"):
	with f.XDMFFile(self.initial_condition.value) as file:
	file.read_checkpoint(
	self.T_n,
	self.initial_condition.label,
	self.initial_condition.time_step,
	)

Proposition

We could have a new class InitialConditionFromXDMF and remove the arguments label, time_step from InitialCondition.

This would make things less confusing and would make the implementation more straightforward, we now just have to check for the type of the initial condition object:

if isintance(initial_condition, F.InitialConditon):
    # do something
elif isinstance(initial_condition, F.InitialConditionFromXDMF):
    # do something else