Skip to content

Commit

Permalink
More docs for recon type
Browse files Browse the repository at this point in the history
  • Loading branch information
adcroft committed Oct 7, 2024
1 parent d005095 commit 2177e78
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/ALE/Recon1d_type.F90
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,15 @@ module Recon1d_type
!> Deferred implementation of the derivative of the reconstruction at a point
procedure(i_dfdx), deferred :: dfdx
!> Deferred implementation of check_reconstruction
!!
!! Returns True if a check fails. Returns False if all checks pass.
!! Checks are about internal of inferred state, for arbitrary inputs.
!! Checks should cover all the expected properties of a reconstruction.
procedure(i_check_reconstruction), deferred :: check_reconstruction
!> Deferred implementation of unit tests for the reconstruction
!!
!! Returns True if a test fails. Returns False if all tests pass.
!! Tests in unit_tests() are usually checks against known (e.g. analytic) solutions.
procedure(i_unit_tests), deferred :: unit_tests
!> Deferred implementation of deallocation
procedure(i_destroy), deferred :: destroy
Expand Down

0 comments on commit 2177e78

Please sign in to comment.