MFlowCode / MFC

Exascale simulation of multiphase/physics fluid dynamics
https://mflowcode.github.io
MIT License
132 stars 56 forks source link

Fix building docs (case.fpp include error) #417 #418

Closed henryleberre closed 1 month ago

henryleberre commented 1 month ago

Description

PR #413's inclusion of #:include 'case.fpp' in src/common/m_variables_conversion.fpp caused documentation builds to fail. This is because no case.fpp file can be #:include'd when post_process's source gets pre-processed through Fypp. This issue only exists when building documentation for post_process and not when building the associated binary because mfc.sh generates an empty case.fpp for it when building the target. This PR makes sure that a case.fpp file always exists, thereby solving the issue.

--case-optimization should still work because the directory in which mfc.sh creates case.fpp files for this feature has higher priority when Fypp searches for includes, than src/common/include where this PR creates an empty case.fpp. See

https://github.com/MFlowCode/MFC/blob/de3e7a1968b748939c7a94c59bf5e9e8b53cd2a7/CMakeLists.txt#L306-L310

Fixes #417.

Type of change

Please delete options that are not relevant.

Scope

How Has This Been Tested?

sbryngelson commented 1 month ago

Excellent, thank you.