Materials, Exports, DerivedQuantities, ... should be a subclass of list

[RemDelaporteMathurin]

Users should be able to do

my_materials = festim.Materials()

tungsten = festim.Material(....)

my_materials.append(tungsten)

To do so, the current Materials class:

FESTIM/festim/materials/materials.py

Lines 10 to 18 in 621769f

	class Materials:
	"""
	Args:
	materials (list, optional): contains festim.Material objects.
	Defaults to [].
	"""
	def __init__(self, materials=[]):
	self.materials = materials

Needs to become:

class Materials(list):

    def __init__(self, *args):
        super().__init__(*args)

Then instead of doing:

my_materials = festim.Materials(......)

for mat in my_materials.materials:
    ...

one would do:

my_materials = festim.Materials(......)

for mat in my_materials:
    ...

Moreover, this:

FESTIM/festim/materials/materials.py

Line 78 in 621769f

for mat in self.materials:

would become:

for mat in self:

Progress track:

• Materials : F.Materials -> subclass of list #694
• Exports : F.Exports -> subclass of list #695
• DerivedQuantities: F.Traps and F.DerivedQuantities -> subclasses of list #697
• Traps: F.Traps and F.DerivedQuantities -> subclasses of list #697

[RemDelaporteMathurin]

Same for Exports, Traps, DerivedQuantities....?

[KulaginVladimir]

@RemDelaporteMathurin. Could you please clarify the practical benefit of it a bit more? As I understand, this enhancement will make more like a built-in class, so the users won't need to manually create lists every time and work with them, but rather use documented methods of the FESTIM class (I assume that the docs also will be modified) + some code refactoring. Am I correct?

[RemDelaporteMathurin]

1. It is super annoying for users to write

my_materials = F.Materials([....])

second_material = my_materials.materials[1]

thanks to this change, this will become much simpler:

my_materials = F.Materials([....])

second_material = my_materials[1]

Same for boundary conditions, traps, derivedquantities, exports, and others.

2. it will clear a lot of the code base

[KulaginVladimir]

Ok, I can try. How we'll handle it: for all classes at once or iteratively?

[RemDelaporteMathurin]

let's start with Materials

[KulaginVladimir]

@RemDelaporteMathurin, what do you think of TXTExports considering its deprecation?

[RemDelaporteMathurin]

@RemDelaporteMathurin, what do you think of TXTExports considering its deprecation?

I would ignore it