Adding New V&V Cases

Verification and validation documentation is located in doc/content/v_and_v. It has the following structure:

Directory/File name	Description
`verification/`	Directory with verification cases
`validation/`	Directory with validation cases
`index.md`	Index with all V&V cases

Adding a New Case

To add a new case, create a new .md file either in verification or validation directory. Ideally, you should be using the provided template to fill in information about the V&V case, as shown below:


!template load file=validation_case.md.template
  name=The Name Of The V&V Test

!template! item key=introduction
Describe why this test case was selected and how it contributes to the V&V.
!template-end!

!template! item key=problem-description
Describe the test apparatus, provide pictures, etc.
!template-end!

!template! item key=model-description
Describe the model used to simulate the experiment.
!template-end!

!template! item key=tests-simulated
List the test performed and include the test results
!template-end!

Citing Other Documents

If you want to reference other documents, create a .bib file with the same base name as your .md file above. Add BibTeX references into this file. Then, use the citation markdown to cite the BibTeX entries as follows

Markdown	Result
`[!cite](gaston2015physics)`	Gaston et al. (2015)
`[!citep](gaston2015physics)`	(Gaston et al., 2015)

You can list multiple entries in a citation tag like this: [!cite](label1, label2, label3).

Updating the List of V&V Cases

Open index.md and add a new row into either the verification or validation table. You will need to supply a name and a short description of the case.

References

D. R. Gaston, C. J. Permann, J. W. Peterson, A. E. Slaughter, D. Andrš, Y. Wang, M. P. Short, D. M. Perez, M. R. Tonks, J. Ortensi, and R. C. Martineau. Physics-based multiscale coupling for full core nuclear reactor simulation. Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour, 84:45–54, October 2015. URL: http://dx.doi.org/10.1016/j.anucene.2014.09.060.

@article{gaston2015physics,
    author = "Gaston, D. R. and Permann, C. J. and Peterson, J. W. and Slaughter, A. E. and Andr\v{s}, D. and Wang, Y. and Short, M. P. and Perez, D. M. and Tonks, M. R. and Ortensi, J. and Martineau, R. C.",
    title = "Physics-based multiscale coupling for full core nuclear reactor simulation",
    journal = "Annals of Nuclear Energy, Special Issue on Multi-Physics Modelling of LWR Static and Transient Behaviour",
    month = "October",
    year = "2015",
    volume = "84",
    pages = "45--54",
    url = "http://dx.doi.org/10.1016/j.anucene.2014.09.060"
}

Adding a New Case
Citing Other Documents
Updating the List of V & V Cases
References