Misc System Design Description

This template follows INL template TEM-140, "IT System Design Description."

commentnote

This document serves as an addendum to Framework System Design Description and captures information for SDD specific to the Misc module.

Introduction

The MOOSE Misc module provides a set of objects that are used to support a variety of simulations performed using other MOOSE modules or MOOSE-based applications. This module relies on MOOSE for solving the systems of equations that are primarily defined by code outside this module, and simply provides commonly-used code objects that can support those calculations. This document describes the system design of the Misc module.

System Purpose

The Software Design Description provided here is description of each object in the system. The pluggable architecture of the underlying framework of the Misc module makes MOOSE and MOOSE-based applications straightforward to develop as each piece of end-user (developer) code that goes into the system follows a well-defined interface for the underlying systems that those object plug into. These descriptions are provided through developer-supplied "markdown" files that are required for all new objects that are developed as part of the Misc module. More information about the design documentation for MOOSE-based applications and like the Misc module can be found in Documenting MOOSE.

System Scope

The MOOSE Misc module is designed only to provide code modules that support the solution of physics models that are primarily defined by other MOOSE modules and MOOSE-based applications.

The Misc module provides several specializations of MOOSE classes that are used to support calculations performed in a variety of physics calculations. These include Kernel, AuxKernel, Material and Postprocessor classes that computing terms in diffusion equations, compute density, internal volume, and perform other similar functions.

Dependencies and Limitations

The MOOSE Misc module inherits the software dependencies of the MOOSE framework, with no additional dependencies.

Definitions and Acronyms

This section defines, or provides the definition of, all terms and acronyms required to properly understand this specification.

Definitions

  • Pull (Merge) Request: A proposed change to the software (e.g. usually a code change, but may also include documentation, requirements, design, and/or testing).

  • Baseline: A specification or product (e.g., project plan, maintenance and operations (M&O) plan, requirements, or design) that has been formally reviewed and agreed upon, that thereafter serves as the basis for use and further development, and that can be changed only by using an approved change control process (NQA-1, 2009).

  • Validation: Confirmation, through the provision of objective evidence (e.g., acceptance test), that the requirements for a specific intended use or application have been fulfilled (24765:2010(E), 2010).

  • Verification: (1) The process of: evaluating a system or component to determine whether the products of a given development phase satisfy the conditions imposed at the start of that phase. (2) Formal proof of program correctness (e.g., requirements, design, implementation reviews, system tests) (24765:2010(E), 2010).

Acronyms

AcronymDescription
APIApplication Programming Interface
DOE-NEDepartment of Energy, Nuclear Energy
FEfinite element
HITHierarchical Input Text
HPCHigh Performance Computing
I/OInput/Output
INLIdaho National Laboratory
MOOSEMultiphysics Object Oriented Simulation Environment
MPIMessage Passing Interface
SDDSoftware Design Description

Design Stakeholders and Concerns

Design Stakeholders

Stakeholders for MOOSE include several of the funding sources including DOE-NE and the INL. However, Since MOOSE is an open-source project, several universities, companies, and foreign governments have an interest in the development and maintenance of the MOOSE project.

Stakeholder Design Concerns

Concerns from many of the stakeholders are similar. These concerns include correctness, stability, and performance. The mitigation plan for each of these can be addressed. For correctness, Misc module development requires either regression or unit testing for all new code added to the repository. The project contains several comparisons against analytical solutions where possible and also other verification methods such as MMS. For stability, the Misc module (located within the MOOSE repository) maintains multiple branches to incorporate several layers of testing both internally and for dependent applications. Finally, performance tests are also performed as part of the the normal testing suite to monitor code change impacts to performance.

System Design

The MOOSE Misc module relies on MOOSE to solve the governing equations for the physics models that it supports. The design of MOOSE is based on the concept of modular code objects that define all of the aspects of the physics model. This module follows this design, providing code objects that define specific aspects of the solutions for its physics that derive from the base classes defined by the MOOSE framework and the modules that it depends on.

The Misc module provides several specializations of MOOSE classes that are used to support calculations performed in a variety of physics calculations. These include Kernel, AuxKernel, Material and Postprocessor classes that computing terms in diffusion equations, compute density, internal volume, and perform other similar functions.

System Structure

The MOOSE Misc module relies on the MOOSE framework to provide the core functionality of solving multiphysics problems using the finite element method. The structure of the Misc module is based on defining C++ classes that derive from base classes in the MOOSE framework to provide functionality for solution of a variety of physics problems. By using the interfaces defined in MOOSE for these classes, this module is able to rely on MOOSE to execute these models at the appropriate times during the simulation and use their results in the desired ways.

Data Design and Control

At a high level, the system is designed to process HIT input files to construct several objects that will constitute an FE simulation. Some of the objects in the simulation may in turn load other file-based resources to complete the simulation. Examples include meshes or data files. The system will then assemble systems of equations and solve them using the libraries of the Code Platform. The system can then output the solution in one or more supported output formats commonly used for visualization.

Human-Machine Interface Design

The Misc module is a command-line driven program. All interaction with the Misc module is ultimately done through the command line. This is typical for HPC applications that use the MPI interface for running on super computing clusters. Optional GUIs may be used to assist in creating input files and launching executables on the command line.

System Design Interface

All external system interaction is performed either through file I/O or through local API calls. Neither the Misc module, nor the MOOSE framework, nor the other MOOSE modules are designed to interact with any external system directly through remote procedure calls. Any code to code coupling performed using the framework are done directly through API calls either in a static binary or after loading shared libraries.

Security Structure

The Misc module does not require any elevated privileges to operate and does not run any stateful services, daemons or other network programs. Distributed runs rely on the MPI library.

Requirements Cross-Reference

  • misc: ArrheniusMaterialProperty
  • 9.1.1The system shall compute a generic material property based on an Arrhenius model that matches an analytic solution of that equation while using the automatic differentiation system.

    Specification(s): exact

    Design: ArrheniusMaterialProperty

    Issue(s): #22384

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 9.1.2The system shall provide perfect derivatives when using ADArrheniusMaterialProperty.

    Specification(s): exact-jac

    Design: ArrheniusMaterialProperty

    Issue(s): #22384

    Collection(s): FUNCTIONAL

    Type(s): PetscJacobianTester

  • 9.2.1The system material shall compute a generic material property based on an Arrhenius model that matches an analytic solution of that equation.

    Specification(s): exact

    Design: ArrheniusMaterialProperty

    Issue(s): #22384

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • misc: MultiApp System
  • 9.4.1The system shall be able to dynamically load a multiapp from a dynamic library.

    Specification(s): dynamic_load

    Design: MultiApp System

    Issue(s): #12266

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 9.4.2The system shall be able to dynamically load a multiapp using the library name, to select a compiling optimization level for example.

    Specification(s): dynamic_load_w_name

    Design: MultiApp System

    Issue(s): #12266

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 9.4.3The system shall report an error if the type of application to dynamically load is not included in the dynamic library.

    Specification(s): dynamic_load_error_check

    Design: MultiApp System

    Issue(s): #12266

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 9.4.4The system shall throw an error message when the library name is manually supplied but does not supply the right application.

    Specification(s): dynamic_load_bad_libary_name

    Design: MultiApp System

    Issue(s): #24751

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 9.4.5The system shall throw an error when no path or environment variable is supplied for dynamic loading.

    Specification(s): dynamic_load_no_path

    Design: MultiApp System

    Issue(s): #24751

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • misc: Misc Module
  • 9.5.1The system shall be able to simulate convective flow through lower-dimensional fractures embedded in a higher-dimensional solid

    Specification(s): test

    Design: Misc Module

    Issue(s): #13318

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

References

  1. ISO/IEC/IEEE 24765:2010(E). Systems and software engineering—Vocabulary. first edition, December 15 2010.[BibTeX]
  2. ASME NQA-1. ASME NQA-1-2008 with the NQA-1a-2009 addenda: Quality Assurance Requirements for Nuclear Facility Applications. first edition, August 31 2009.[BibTeX]