Mixed order recovery #524

Witt-D · 2024-07-23T15:28:47Z

Code to build/find the necessary spaces for recovered transport for lowest order / mixed order finite element domains.

Spaces are found and build bespoke to the family of the de-Rham complex

… mixed-order-recovery

jshipton · 2024-07-23T16:26:09Z

gusto/recovery/recovery_options.py

+    """
+
+    def __init__(self, domain):
+


needs some interface documentation

jshipton · 2024-07-23T16:27:10Z

Great - thanks @Witt-D ! We need a / some tests(s) for this - I can't see that the new code is currently used anywhere...

tommbendall

I think this is looking good -- I have a few suggestions but I'm really happy with what this will look like

tommbendall · 2024-07-23T18:59:47Z

gusto/recovery/recovery_options.py

@@ -0,0 +1,67 @@
+


Could you add some docs for the module?

tommbendall · 2024-07-23T19:01:58Z

gusto/recovery/recovery_options.py

+        DG_recovered_space = self.domain.spaces.H1
+
+        self.DG_options = RecoveryOptions(embedding_space=DG_embedding_space,
+                                          recovered_space=DG_recovered_space)


Should we also add the boundary method here, based on the domain?

tommbendall · 2024-07-23T19:02:38Z

gusto/recovery/recovery_options.py

+        self.build_DG_options()
+        self.build_HDiv_options()
+
+    def build_DG_options(self):


Does this need to be its own function? Or could it be part of the init method?

I don't have particularly strong feelings one way or another about this. I wrote it this way as I found it easier to keep track of the different options when coding it up. I'm happy for it to be in the ini

tommbendall · 2024-07-23T19:05:04Z

gusto/recovery/recovery_options.py

+        DG_hori_ele = FiniteElement('DG', self.cell, 1, variant='equispaced')
+        DG_vert_ele = FiniteElement('DG', interval, 2, variant='equispaced')
+        CG_hori_ele = FiniteElement('CG', self.cell, 1)
+        CG_vert_ele = FiniteElement('CG', interval, 2)


I don't think we always want this to be degree 2? Maybe we do for some cases but not all -- so I think we need an argument controlling which degrees we use for the theta space?

tommbendall · 2024-07-23T19:09:27Z

Great - thanks @Witt-D ! We need a / some tests(s) for this - I can't see that the new code is currently used anywhere...

I think we could use this in some existing tests:

the dry Bryan and Fritsch example (https://github.com/firedrakeproject/gusto/blob/main/examples/compressible/dry_bryan_fritsch.py)
the unsaturated bubble example (https://github.com/firedrakeproject/gusto/blob/main/examples/compressible/unsaturated_bubble.py)

And if we want to be really thorough, we should add a unit-test specifically testing that the spaces set up have the appropriate degrees

…ake8

jshipton · 2024-07-29T10:04:27Z

examples/compressible/dry_bryan_fritsch.py

-                           boundary_method=BoundaryMethod.taylor)
-theta_opts = RecoveryOptions(embedding_space=VDG1,
-                             recovered_space=VCG1)
+recovery_spaces = RecoverySpaces(domain)


boundary methods are required for this example

I think we also want use_vector_spaces=True

jshipton · 2024-07-29T10:04:48Z

examples/compressible/unsaturated_bubble.py

 # Transport schemes -- specify options for using recovery wrapper
+recovery_spaces = RecoverySpaces(domain)


boundary methods are required here

and also use_vector_spaces=True

jshipton · 2024-07-29T10:06:43Z

gusto/recovery/recovery_options.py

+            domain (:class:`Domain`): the model's domain object, containing the
+            mesh and the compatible function spaces.
+
+            boundary_method (:variable:'dict'): A dictionary containing the space


Specify that this is an optional argument and give its default value.

jshipton · 2024-07-29T10:08:38Z

gusto/recovery/recovery_options.py

+            mesh and the compatible function spaces.
+
+            boundary_method (:variable:'dict'): A dictionary containing the space
+            it applies to along with the chosen method. Acceptable keys are "DG",


what is the use_vector_spaces argument? please document.

jshipton · 2024-07-29T10:09:27Z

gusto/recovery/recovery_options.py

+                                            project_low_method='project',
+                                            broken_method='project',
+                                            boundary_method=HDiv_boundary_method)
+        # ----------------------------------------------------------------------


comment not in right place

jshipton · 2024-07-29T10:16:07Z

@tommbendall do we need an integration test or example that sets up and runs a problem on mixed order spaces?

tommbendall · 2024-07-29T10:58:37Z

@tommbendall do we need an integration test or example that sets up and runs a problem on mixed order spaces?

We could add a travelling vortex to the examples? But I think that could also happen in a different PR

… mixed-order-recovery

jshipton · 2024-07-29T13:50:06Z

gusto/recovery/recovery_options.py

+            domain (:class:`Domain`): the model's domain object, containing the
+            mesh and the compatible function spaces.
+
+            boundary_method (:variable:'dict', optional: A dictionary containing the space


close brackets, use consistent formatting for the keys, new sentence for the default.

I think you might also need the other quotation marks, for consistency with the other comments and possibly for how the docs are formatted.

jshipton · 2024-07-29T13:52:59Z

gusto/recovery/recovery_options.py

+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
+            "HDiv" and theta, defaults to None
+
+            use_vector_spaces (boolean, optional) Determins if we need to use DG / CG


spelling: determines and Hcurl, bool rather than boolean and put a colon after the type - necessary for consistency but also because this can affect how the docs look

tommbendall

This is very nearly there, there's still just a few things to tidy up in the docstrings

tommbendall · 2024-08-01T14:49:38Z

gusto/recovery/recovery_options.py

+        """
+        Args:
+            domain (:class:`Domain`): the model's domain object, containing the
+            mesh and the compatible function spaces.


Could you indent the continuation lines, so that it's clear which are the variables?

tommbendall · 2024-08-01T14:50:27Z

gusto/recovery/recovery_options.py

@@ -0,0 +1,119 @@
+


I think we could still do with a docstring at the top of the file describing what this module contains, e.g.
"""Contains an object to generate the set of spaces used for the recovery wrapper."""

tommbendall · 2024-08-01T14:51:43Z

gusto/recovery/recovery_options.py

+
+            boundary_method (:variable:'dict', optional): A dictionary containing the space
+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
+            "HDiv" and "theta". acceptable values are (BoundaryMetghod.taylor/hcurl/extruded),


Suggested change

"HDiv" and "theta". acceptable values are (BoundaryMetghod.taylor/hcurl/extruded),

"HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),

tommbendall · 2024-08-01T14:52:06Z

gusto/recovery/recovery_options.py

+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
+            "HDiv" and "theta". acceptable values are (BoundaryMetghod.taylor/hcurl/extruded),
+            passed as ('space', 'boundary method')
+            Defaults to None


The Defaults to should be on the same line

tommbendall

There's one more typo to fix! And about the continuation lines -- documentation of arguments that go over one line need indenting also. I've put suggestions in

tommbendall · 2024-08-02T15:56:22Z

gusto/recovery/recovery_options.py

+        """
+        Args:
+            domain (:class:`Domain`): the model's domain object, containing the
+            mesh and the compatible function spaces.


Suggested change

mesh and the compatible function spaces.

mesh and the compatible function spaces.

tommbendall · 2024-08-02T15:56:42Z

gusto/recovery/recovery_options.py

+            mesh and the compatible function spaces.
+
+            boundary_method (:variable:'dict', optional): A dictionary containing the space
+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",


Suggested change

the boundary method is to be applied to along with specified method. Acceptable keys are "DG",

the boundary method is to be applied to along with specified method. Acceptable keys are "DG",

tommbendall · 2024-08-02T15:56:57Z

gusto/recovery/recovery_options.py

+
+            boundary_method (:variable:'dict', optional): A dictionary containing the space
+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
+            "HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),


Suggested change

"HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),

"HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),

tommbendall · 2024-08-02T15:57:09Z

gusto/recovery/recovery_options.py

+            boundary_method (:variable:'dict', optional): A dictionary containing the space
+            the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
+            "HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),
+            passed as ('space', 'boundary method'). Defaults to None


Suggested change

passed as ('space', 'boundary method'). Defaults to None

passed as ('space', 'boundary method'). Defaults to None

tommbendall · 2024-08-02T15:57:24Z

gusto/recovery/recovery_options.py

+            passed as ('space', 'boundary method'). Defaults to None
+
+            use_vector_spaces (bool, optional):. Determines if we need to use DG / CG
+            space for the embedded and recovery space for the HDiv field instead of the usual


Suggested change

space for the embedded and recovery space for the HDiv field instead of the usual

space for the embedded and recovery space for the HDiv field instead of the usual

tommbendall · 2024-08-02T15:57:37Z

gusto/recovery/recovery_options.py

+
+            use_vector_spaces (bool, optional):. Determines if we need to use DG / CG
+            space for the embedded and recovery space for the HDiv field instead of the usual
+            HDiv, HCurl spaces. Defaults to False


Suggested change

HDiv, HCurl spaces. Defaults to False

HDiv, HCurl spaces. Defaults to False

tommbendall · 2024-08-02T15:57:54Z

gusto/recovery/recovery_options.py

@@ -0,0 +1,117 @@
+"""Contains an obect to generate the set of spaces used for the recovery wrapper """


Suggested change

"""Contains an obect to generate the set of spaces used for the recovery wrapper """

"""Contains an object to generate the set of spaces used for the recovery wrapper """

tommbendall

Thanks Dan! This looks great now

Witt-D added 7 commits July 23, 2024 10:04

added new recovery space function

7a134a0

Merge branch 'main' of https://github.com/firedrakeproject/gusto into…

0bb4b2f

… mixed-order-recovery

updated where spaces are found

8714e80

flake8

e0d4b74

flake8

ee4379a

Merge branch 'main' of https://github.com/firedrakeproject/gusto into…

27c4446

… mixed-order-recovery

flake8 for real

c5ba83b

jshipton reviewed Jul 23, 2024

View reviewed changes

gusto/recovery/recovery_options.py

"""

def __init__(self, domain):

Copy link

Contributor

jshipton Jul 23, 2024

Choose a reason for hiding this comment

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

needs some interface documentation

tommbendall requested changes Jul 23, 2024

View reviewed changes

Witt-D added 4 commits July 24, 2024 09:21

changed the recovery options to use the new system

a877c4e

used new recovery mechanism

bbc1296

flake8 compliance

a18630b

added recovery options as well as the corresponding unit test, all fl…

173dbc1

…ake8

jshipton reviewed Jul 29, 2024

View reviewed changes

Witt-D added 3 commits July 29, 2024 13:35

Merge branch 'main' of https://github.com/firedrakeproject/gusto into…

f2cb9f8

… mixed-order-recovery

added examples and modified the recovery class

09ef0c0

flake8 fixes!

7c84490

jshipton reviewed Jul 29, 2024

View reviewed changes

Witt-D added 2 commits August 1, 2024 14:35

fixed failing tests and flake8

545fb91

fixed small typo

5d2f5c7

tommbendall requested changes Aug 1, 2024

View reviewed changes

final changes hopefully

cfcaf28

tommbendall requested changes Aug 2, 2024

View reviewed changes

tommbendall added enhancement Pull requests or issues relating to adding a new capability tidying Pull requests or issues that involve tidying up code labels Aug 7, 2024

final adjustments (hopefully)

4f36170

tommbendall approved these changes Aug 7, 2024

View reviewed changes

Merge branch 'main' into mixed-order-recovery

5393c08

tommbendall merged commit f731dee into main Aug 7, 2024
4 checks passed

tommbendall deleted the mixed-order-recovery branch August 7, 2024 15:47

		# Transport schemes -- specify options for using recovery wrapper
		recovery_spaces = RecoverySpaces(domain)

	"HDiv" and "theta". acceptable values are (BoundaryMetghod.taylor/hcurl/extruded),
	"HDiv" and "theta". acceptable values are (BoundaryMethod.taylor/hcurl/extruded),

	mesh and the compatible function spaces.
	mesh and the compatible function spaces.

	the boundary method is to be applied to along with specified method. Acceptable keys are "DG",
	the boundary method is to be applied to along with specified method. Acceptable keys are "DG",

	passed as ('space', 'boundary method'). Defaults to None
	passed as ('space', 'boundary method'). Defaults to None

	space for the embedded and recovery space for the HDiv field instead of the usual
	space for the embedded and recovery space for the HDiv field instead of the usual

	HDiv, HCurl spaces. Defaults to False
	HDiv, HCurl spaces. Defaults to False

		@@ -0,0 +1,117 @@
		"""Contains an obect to generate the set of spaces used for the recovery wrapper """

	"""Contains an obect to generate the set of spaces used for the recovery wrapper """
	"""Contains an object to generate the set of spaces used for the recovery wrapper """

Mixed order recovery #524

Mixed order recovery #524

Conversation

Witt-D commented Jul 23, 2024

Choose a reason for hiding this comment

jshipton commented Jul 23, 2024

tommbendall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tommbendall commented Jul 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jshipton commented Jul 29, 2024

tommbendall commented Jul 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tommbendall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tommbendall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tommbendall left a comment

Choose a reason for hiding this comment