Customising stuff saved in the dump files

[jeankpf]

Hi all,

I was wondering whether any of you already tried to custom the content of a dump file, like adding a 1D vector for instance.

In the context of a forcing module that I am currently developping, I need the record of all the different timesteps used during each cycle if I want to restart a stopped simulation. I created such a vector, as an attribute to either the TimeIntegrator or DataBlock objects. But now I need this vector to be included in the dump file when the forcing module was activated during the simulation. I don't know how easy, or not, this is to implement, but a quick look at the dump.cpp and .hpp files was not enough for me to know how to proceed.

If anyone already encountered similar considerations, feel free to drop in!

[neutrinoceros]

Dump::RegisterVariable is likely the function you're looking for, although I think you'll need to implement a 1D variant, and extend DumpField for this dimensionality. This will require:

• extending the DumpField::ArrayType enum to include Device1D and Host1D variants
• overloading the constructor
• adding dedicated if constexpr branches to DumpField::GetHostField and DumpField::SyncFrom

this should be about it

[jeankpf]

Good to know this way around, thank you very much!

[jeankpf]

Hi, I'm sorry I'm coming back to this thread, but how would you unregister an array that has been previously registered? I didn't find the relevant function in the src code :/

[glesur]

no, you can't unregister a variable, there has never been a use for this. This should not be so hard: a dumpFieldMap.find(xxxx) followed by a dumpFieldMap.erase() should do it.

[neutrinoceros]

On my phone right now so I can't check, but I think I implemented unregistering on the (still private) particles branch.

[neutrinoceros]

Nevermind. I just checked: particles require registering the same variables more than once (e.g., every time a change of size occurs), and this works by simply calling data->dump->RegisterVariable again, but I never actually needed to completely unregister arrays.