Skip to content

Commit

Permalink
Clamp down expected outputs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tkphd committed Mar 16, 2023
1 parent 487b45e commit 486e5d2
Show file tree
Hide file tree
Showing 2 changed files with 163 additions and 139 deletions.
59 changes: 47 additions & 12 deletions benchmarks/benchmark1.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1001,13 +1001,57 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Results"
"## Submission Guidelines\n",
"\n",
"Please follow these [upload instructions](https://github.com/usnistgov/pfhub/blob/master/upload.md).\n",
"\n",
"In addition to that specified, further data to upload can include a Youtube video, images of the nuclei at different times, or the entire phase field variable at different times. This data can be uploaded directly to the website or stored at a secondary location and only the link to the data provided. This data is not required, but will help others view your work.\n",
"\n",
"### Part (a)\n",
"\n",
"Part (a) requires running the simulation to equilibrium, and the following data should be collected.\n",
"\n",
"- The free energy integrated over the whole domain, $\\mathcal{F}$, at each timestep. \n",
"\n",
" One PFHub upload is required for all the simulations. The free energy data should be recorded in a file named needs to be `free_energy_1a.csv`. This CSV file (comma-separated value) must have the following format: note the column headings and lack of spaces.\n",
"\n",
" ```\n",
" time,free_energy\n",
" 0.00000000,319.0337102\n",
" 5.00000000,318.8273928\n",
" ...\n",
" 10000.0000,40.81065093\n",
" ...\n",
" ```\n",
" \n",
"- The phase field, $c$, at each grid point in the domain at the following times (aspirational):\n",
" - 1,000\n",
" - 10,000\n",
" - 100,000\n",
" - 1,000,000\n",
"\n",
" You may provide this data in whatever format you consider \"most useful,\" and we shall endeavour to deal with that, e.g. a checkpoint file in the format native to your phase-field simulation framework.\n",
" Optionally, please consider also uploading a VTK ImageData file. If your mesh is unstructured or irregular, this will require appropriate interpolation prior to export. This can be accomplished in ParaView using the PointVolumeInterpolator filter.<sup>&#8225;</sup>\n",
"\n",
" The names of these data files should encode the time and problem, e.g.,\n",
" `raw_data_1a.0001000.vti`,\n",
" `raw_data_1a.0010000.vti`,\n",
" `raw_data_1a.0100000.vti`, and\n",
" `raw_data_1a.1000000.vti`.\n",
"\n",
"### Parts (b) through (d)\n",
"\n",
"The same data as in Part (a) are required; please follow the same instructions, modifying \"1a\" with the appropriate letter (\"1b\", \"1c\", etc.).\n",
"\n",
"<sup>&#8225;</sup>: Any mention of commercial products within NIST web pages is for information only; it does not imply recommendation or endorsement by NIST."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Results\n",
"\n",
"Results from this benchmark problem are displayed on the [simulation result page]({{ site.baseurl }}/simulations) for different codes."
]
},
Expand All @@ -1019,21 +1063,12 @@
"\n",
"Feedback on this benchmark problem is appreciated. If you have questions, comments, or seek clarification, please contact the [CHiMaD phase field community]({{ site.baseurl }}/community/) through the [Gitter chat channel]({{ site.links.chat }}) or by [email]({{ site.baseurl }}/mailing_list/). If you found an error, please file an [issue on GitHub]({{ site.links.github }}/issues/new)."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": []
}
],
"metadata": {
"anaconda-cloud": {},
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -1047,7 +1082,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.4"
"version": "3.9.16"
}
},
"nbformat": 4,
Expand Down
Loading

0 comments on commit 486e5d2

Please sign in to comment.