Update CCE tutorial #6029

knelli2 · 2024-05-24T06:11:47Z

Proposed changes

Update the CCE tutorial to be a bit more comprehensive.

Upgrade instructions

Code review checklist

The code is documented and the documentation renders correctly. Run
make doc to generate the documentation locally into BUILD_DIR/docs/html.
Then open index.html.
The code follows the stylistic and code quality guidelines listed in the
code review guide.
The PR lists upgrade instructions and is labeled bugfix or
new feature if appropriate.

Further comments

nilsdeppe

overall LGTM! A few small suggestions!

nilsdeppe · 2024-05-29T14:14:21Z

docs/Tutorials/CCE.md

+### Initial data on the null hypersurface
+
+Choosing initial data on the initial null hypersurface is a non-trivial task and
+is an active are of research. We want initial data that will reduce the amount


active are -> active area

nilsdeppe · 2024-05-29T14:21:12Z

docs/Tutorials/CCE.md

+
+This is even more apparent if you plot the amplitude of the two waveforms. It's
+pretty clear which waveform is the more "physical" one. Notice that there are
+still some oscillations in the strain produced from sci towards the beginning


sci -> scri?

nilsdeppe · 2024-05-29T14:23:50Z

docs/Tutorials/CCE.md

+\image html im_h22.png "Imaginary part of 2,2 component of the strain"
+
+This is even more apparent if you plot the amplitude of the two waveforms. It's
+pretty clear which waveform is the more "physical" one. Notice that there are


Suggested change

pretty clear which waveform is the more "physical" one. Notice that there are

pretty clear which waveform is the more "physical" one.

\image html amp_im_h22.png "Amplitude of imaginary part of 2,2 component of the strain"

Notice that there are still some oscillations in the strain produced from scri towards

the beginning of the waveform (up to ~1500M).

nilsdeppe · 2024-05-29T14:24:23Z

docs/Tutorials/CCE.md

+  `Cce.Evolution.StepChoosers.Constant` option set to 0.1 for an accurate time
+  evolution. However, if you're just testing, this can be increased to 0.5 to
+  speed things up.
+- We do not recommend extracting at 100M or less due to the junk radiation


which junk radiation? CCE or Cauchy/initial data?

Yeah 100M can be fine for certain simulation. Do we want to say something about how it might be best to run CCE for various worldtubes and then check which one is best via, e.g., bianchi identity violations?

I like that suggestion! We could maybe do both? Give a estimate like "Generally, using a worldtube radius of 200M is a reasonable choice, but you should check the Bianchi identity violations to test." Do we have a scri tutorial on how to do that?

Not currently! But I’ll make a PR to add it to the tutorial

Cool! Thanks!

nilsdeppe · 2024-05-29T14:24:40Z

docs/Tutorials/CCE.md

+
+Choosing initial data on the initial null hypersurface is a non-trivial task and
+is an active are of research. We want initial data that will reduce the amount
+of junk radiation as much as possible, while also having the initial data work


Suggested change

of junk radiation as much as possible, while also having the initial data work

of CCE junk radiation as much as possible, while also having the initial data work

nilsdeppe · 2024-05-29T14:25:06Z

docs/Tutorials/CCE.md

+  This will work for many cases, but not all. But will produce the best initial
+  data when it does work.
+- `InverseCubic`: Ansatz where \f$J = A/r + B/r^3\f$. This is very robust and
+  almost never fails, but contains a lot of junk.


Suggested change

almost never fails, but contains a lot of junk.

almost never fails, but contains a lot of CCE junk radiation compare to `ConformalFactor`.

*compare -> compared

nilsdeppe · 2024-05-29T14:25:25Z

docs/Tutorials/CCE.md

+This is even more apparent if you plot the amplitude of the two waveforms. It's
+pretty clear which waveform is the more "physical" one. Notice that there are
+still some oscillations in the strain produced from sci towards the beginning
+of the waveform. This is caused by junk radiation from imperfect initial data on


Suggested change

of the waveform. This is caused by junk radiation from imperfect initial data on

of the waveform. This is caused by CCE junk radiation from imperfect initial data on

nilsdeppe · 2024-05-29T14:25:38Z

docs/Tutorials/CCE.md

+pretty clear which waveform is the more "physical" one. Notice that there are
+still some oscillations in the strain produced from sci towards the beginning
+of the waveform. This is caused by junk radiation from imperfect initial data on
+the null hypersurface. In order to use this waveform in analysis, the junk must


Suggested change

the null hypersurface. In order to use this waveform in analysis, the junk must

the null hypersurface. In order to use this waveform in analysis, the CCE junk radiation must

nilsdeppe · 2024-05-29T14:26:51Z

docs/Tutorials/CCE.md

+improper BMS frame that the SpECTRE CCE waveform is in. A supertranslation must
+be applied go transform the waveform into the correct BMS frame. See
+\cite Mitman2024review for a review of BMS transformations and gravitational
+memory.


Suggested change

memory.

memory. The plot below shows the output of SpECTRE CCE as well as the output after using scri to do

the BMS frame transformation (see LINK KEEFE's TUTORIAL for help with how to perform the frame fixing).

Do we want to include the example code in the scri abd tutorial for plotting a waveform? Or just link to it?

I'm fine just linking to it but have no preference either way :)

I already mention that the plot is raw CCE vs scri in the first sentence of this paragraph. I'll add the link to Keefe's tutorial here

keefemitman · 2024-05-29T17:57:04Z

docs/Tutorials/CCE.md

@@ -6,152 +6,59 @@ See LICENSE.txt for details.

 \tableofcontents


Maybe it's just on my end, but if I view this .md file on Kyle's branch then a lot of the commands seem broken? Like the table of contents doesn't actually load...

For looking at docs, go to the checks and download the docs-html artifact. Then I just open the html in a local browser

keefemitman · 2024-05-29T18:01:13Z

docs/Tutorials/CCE.md

+  `Cce.Evolution.StepChoosers.Constant` option set to 0.1 for an accurate time
+  evolution. However, if you're just testing, this can be increased to 0.5 to
+  speed things up.
+- We do not recommend extracting at 100M or less due to the junk radiation


Yeah 100M can be fine for certain simulation. Do we want to say something about how it might be best to run CCE for various worldtubes and then check which one is best via, e.g., bianchi identity violations?

keefemitman · 2024-05-29T18:02:02Z

docs/Tutorials/CCE.md

+  This will work for many cases, but not all. But will produce the best initial
+  data when it does work.
+- `InverseCubic`: Ansatz where \f$J = A/r + B/r^3\f$. This is very robust and
+  almost never fails, but contains a lot of junk.


*compare -> compared

keefemitman · 2024-05-29T18:02:46Z

docs/Tutorials/CCE.md

+
+The `Strain` represents the asymptotic transverse-traceless contribution
+to the metric scaled by the Bondi radius (to give the asymptotically leading
+part), the `News` represents the first derivative of the strain, and each


first derivative -> first time derivative

keefemitman · 2024-05-29T18:04:35Z

docs/Tutorials/CCE.md

+improper BMS frame that the SpECTRE CCE waveform is in. A supertranslation must
+be applied go transform the waveform into the correct BMS frame. See
+\cite Mitman2024review for a review of BMS transformations and gravitational
+memory.


Do we want to include the example code in the scri abd tutorial for plotting a waveform? Or just link to it?

keefemitman · 2024-05-29T18:05:31Z

docs/Tutorials/CCE.md

+
+This is even more apparent if you plot the amplitude of the two waveforms. It's
+pretty clear which waveform is the more "physical" one. Notice that there are
+still some oscillations in the strain produced from sci towards the beginning


produced from -> output by

keefemitman · 2024-05-29T18:05:50Z

docs/Tutorials/CCE.md

+still some oscillations in the strain produced from sci towards the beginning
+of the waveform. This is caused by junk radiation from imperfect initial data on
+the null hypersurface. In order to use this waveform in analysis, the junk must
+be cut off from the end.


end -> beginning

keefemitman · 2024-05-29T18:06:30Z

docs/Tutorials/CCE.md

+You are also able to see gravitational memory effects with SpECTRE CCE! This
+shows up in the real part of the 2,0 mode of the strain. Though you can see the
+memory effects in the SpECTRE CCE waveform, in order to do any analysis, you
+must also transform the waveform into the correct BMS frame.


into the correct -> to a more physically motivated

knelli2 · 2024-05-29T22:22:28Z

@keefemitman @nilsdeppe pushed a fixup

nilsdeppe

LGTM! A few minor suggestions. I'm happy for you to squash once Keefe's happy :)

The SpEC simulation is running now!

nilsdeppe · 2024-05-30T01:23:20Z

docs/Tutorials/CCE.md

-  being much worse at these smaller worldtube radii.
+- We generally do not recommend extracting at less than 100M due to the CCE junk
+  radiation being much worse at these smaller worldtube radii. That being said,
+  we also recommend running CCE for several worldtube radii and check which on


and check -> and checking

remove on at the end

nilsdeppe · 2024-05-30T01:23:58Z

docs/Tutorials/CCE.md

+- We generally do not recommend extracting at less than 100M due to the CCE junk
+  radiation being much worse at these smaller worldtube radii. That being said,
+  we also recommend running CCE for several worldtube radii and check which on
+  is the best based on the bianchi identity violations. There isn't necessarily


bianchi -> Bianchi?

keefemitman · 2024-05-30T15:05:07Z

@keefemitman @nilsdeppe pushed a fixup

I'm happy!

knelli2 force-pushed the cce_tutorial_update branch 5 times, most recently from e97e4f8 to f062058 Compare May 29, 2024 05:07

knelli2 marked this pull request as ready for review May 29, 2024 05:07

knelli2 requested a review from nilsdeppe May 29, 2024 05:08

nilsdeppe requested changes May 29, 2024

View reviewed changes

keefemitman suggested changes May 29, 2024

View reviewed changes

nilsdeppe reviewed May 30, 2024

View reviewed changes

knelli2 force-pushed the cce_tutorial_update branch from 10993f4 to 290eadc Compare May 30, 2024 02:23

Update CCE tutorial

6a586c4

knelli2 force-pushed the cce_tutorial_update branch from 290eadc to 6a586c4 Compare May 31, 2024 22:51

nilsdeppe approved these changes May 31, 2024

View reviewed changes

nilsdeppe merged commit edead37 into sxs-collaboration:develop Jun 1, 2024
22 checks passed

nilsvu added the documentation label Jun 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CCE tutorial #6029

Update CCE tutorial #6029

knelli2 commented May 24, 2024 •

edited

Loading

nilsdeppe left a comment

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

keefemitman May 29, 2024

nilsdeppe May 29, 2024

keefemitman May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

keefemitman May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

nilsdeppe May 29, 2024

keefemitman May 29, 2024

nilsdeppe May 29, 2024

knelli2 May 29, 2024

keefemitman May 29, 2024

knelli2 May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

keefemitman May 29, 2024

knelli2 commented May 29, 2024

nilsdeppe left a comment

nilsdeppe May 30, 2024

nilsdeppe May 30, 2024

keefemitman commented May 30, 2024

-pretty clear which waveform is the more "physical" one. Notice that there are
+pretty clear which waveform is the more "physical" one.
+\image html amp_im_h22.png "Amplitude of imaginary part of 2,2 component of the strain"
+Notice that there are still some oscillations in the strain produced from scri towards
+the beginning of the waveform (up to ~1500M).

	of junk radiation as much as possible, while also having the initial data work
	of CCE junk radiation as much as possible, while also having the initial data work

	almost never fails, but contains a lot of junk.
	almost never fails, but contains a lot of CCE junk radiation compare to `ConformalFactor`.

	of the waveform. This is caused by junk radiation from imperfect initial data on
	of the waveform. This is caused by CCE junk radiation from imperfect initial data on

	the null hypersurface. In order to use this waveform in analysis, the junk must
	the null hypersurface. In order to use this waveform in analysis, the CCE junk radiation must

	memory.
	memory. The plot below shows the output of SpECTRE CCE as well as the output after using scri to do
	the BMS frame transformation (see LINK KEEFE's TUTORIAL for help with how to perform the frame fixing).

		@@ -6,152 +6,59 @@ See LICENSE.txt for details.

		\tableofcontents

Update CCE tutorial #6029

Update CCE tutorial #6029

Conversation

knelli2 commented May 24, 2024 • edited Loading

Proposed changes

Upgrade instructions

Code review checklist

Further comments

nilsdeppe 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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

knelli2 commented May 29, 2024

nilsdeppe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keefemitman commented May 30, 2024

knelli2 commented May 24, 2024 •

edited

Loading