Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warn about derived quantities in non cartesian #688

Conversation

RemDelaporteMathurin
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin commented Jan 23, 2024

Proposed changes

This PR adds a warning when users employ SurfaceFlux with a non-cartesian mesh (eg. an axisymmetric 2D mesh).

Indeed, the flux (example here for particles) expression is

$$ J_\mathrm{total} = \int J \cdot n \ dS $$

where $n$ is the normal vector and

$$ J = - D \nabla c $$

In cartesian coordinates, the element $dS$ is $dS = dx \ dy $, assuming it is $y$ independent $dS = y \ dx$.
And this is the default behaviour in fenics.

However in cylindrical $(r, \theta, z)$, the surface element is $dS = r \ dr \ d\theta$, assuming it is axisymmetric ($\theta$ independent), then $dS =\theta \ r \ dr$

The flux becomes:

$$ J_\mathrm{total} = \int J \cdot n \ dS = \theta \int r \ J \cdot n \ dr $$

which is NOT the default behaviour of SurfaceFlux.
While we wait for a native support of fluxes in cylindrical coordinates to be implemented, users should at least be warn that this may be an issue.

The same goes for TotalVolume , AverageVolume , etc.

Thanks @WeaverC20 for helping spotting this

Types of changes

What types of changes does your code introduce to FESTIM?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring
  • Documentation Update (if none of the other choices apply)
  • New tests

Checklist

  • Black formatted
  • Unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (49d18e8) 99.47% compared to head (33c4288) 99.47%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #688   +/-   ##
=======================================
  Coverage   99.47%   99.47%           
=======================================
  Files          58       58           
  Lines        2280     2286    +6     
=======================================
+ Hits         2268     2274    +6     
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RemDelaporteMathurin RemDelaporteMathurin changed the title Warn about surface flux in non cartesian Warn about derived quantities in non cartesian Jan 23, 2024
@RemDelaporteMathurin
Copy link
Collaborator Author

@jhdark can we merge this before #689 ?

Copy link
Collaborator

@jhdark jhdark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@RemDelaporteMathurin RemDelaporteMathurin merged commit 91e59ac into festim-dev:main Feb 27, 2024
5 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the warn-about-SurfaceFlux-in-non-cartesian branch February 27, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants