search

precice / fenics-adapter

preCICE-adapter for the open source computing platform FEniCS
GNU Lesser General Public License v3.0
29 stars 15 forks source link

Outdated documentation regarding actions #139

Closed davidscn closed 2 years ago

davidscn commented 3 years ago

https://github.com/precice/fenics-adapter/blob/69a16bdf9d237e512e2e1ae9ef4ed1bb983ea5b9/fenicsprecice/fenicsprecice.py#L560

The referenced link doesn't work and is outdated (amongst others in this file). In particular, I'm looking for the action actionWriteInitialData, but I couldn't find any documentation on this. Is it available at all?

IshaanDesai commented 3 years ago

Thanks @DavidSCN for pointing out the outdated link! We will update this :+1: The action actionWriteInitialData is found in the Python bindings as action_write_initial_data. Is this what you are looking for?

davidscn commented 3 years ago

The action actionWriteInitialData is found in the Python bindings as action_write_initial_data. Is this what you are looking for?

Yes. Is it supposed to be used directly in fenics? Later, I saw that the function is actually already used in the adapter during initialization.

IshaanDesai commented 3 years ago

Yes. Is it supposed to be used directly in fenics? Later, I saw that the function is actually already used in the adapter during initialization.

Using this particular function in FEniCS depends on how you want to couple your FEniCS code using preCICE. If you directly want to use the Python bindings in the FEniCS code then yes you will need to use this function directly in the code. If you want to use the adapter (highly recommended) then the action of writing initial data is taken care off in the initialize function of the adapter so that the user does not have to worry about it.

IshaanDesai commented 2 years ago

Resolved in https://github.com/precice/fenics-adapter/commit/f517f2c27b3b2ccf0f0c90359253079ff976833e