EigenProblem

construction:Undocumented Class

The EigenProblem has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# EigenProblem

!syntax description /Problem/EigenProblem

## Overview

!! Replace these lines with information regarding the EigenProblem object.

## Example Input File Syntax

!! Describe and include an example of how to use the EigenProblem object.

!syntax parameters /Problem/EigenProblem

!syntax inputs /Problem/EigenProblem

!syntax children /Problem/EigenProblem

Problem object for solving Eigen value problem.

Input Parameters

active_eigen_index0Which eigen vector is used to compute residual and also associateed to nonlinear variable
Default:0
C++ Type:unsigned int
Options:
Description:Which eigen vector is used to compute residual and also associateed to nonlinear variable
blockBlock IDs for the coordinate systems
C++ Type:std::vector<SubdomainName>
Options:
Description:Block IDs for the coordinate systems
coord_typeXYZType of the coordinate system per block param
Default:XYZ
C++ Type:MultiMooseEnum
Options:XYZ, RZ, RSPHERICAL
Description:Type of the coordinate system per block param
error_on_jacobian_nonzero_reallocationFalseThis causes PETSc to error if it had to reallocate memory in the Jacobian matrix due to not having enough nonzeros
Default:False
C++ Type:bool
Options:
Description:This causes PETSc to error if it had to reallocate memory in the Jacobian matrix due to not having enough nonzeros
extra_tag_matricesExtra matrices to add to the system that can be filled by objects which compute residuals and Jacobians (Kernels, BCs, etc.) by setting tags on them.
C++ Type:std::vector<TagName>
Options:
Description:Extra matrices to add to the system that can be filled by objects which compute residuals and Jacobians (Kernels, BCs, etc.) by setting tags on them.
extra_tag_solutionsExtra solution vectors to add to the system that can be used by objects for coupling variable values stored in them.
C++ Type:std::vector<TagName>
Options:
Description:Extra solution vectors to add to the system that can be used by objects for coupling variable values stored in them.
extra_tag_vectorsExtra vectors to add to the system that can be filled by objects which compute residuals and Jacobians (Kernels, BCs, etc.) by setting tags on them.
C++ Type:std::vector<TagName>
Options:
Description:Extra vectors to add to the system that can be filled by objects which compute residuals and Jacobians (Kernels, BCs, etc.) by setting tags on them.
force_restartFalseEXPERIMENTAL: If true, a sub_app may use a restart file instead of using of using the master backup file
Default:False
C++ Type:bool
Options:
Description:EXPERIMENTAL: If true, a sub_app may use a restart file instead of using of using the master backup file
fv_bcs_integrity_checkTrueSet to false to disable checking of overlapping Dirichlet and Flux BCs and/or multiple DirichletBCs per sideset
Default:True
C++ Type:bool
Options:
Description:Set to false to disable checking of overlapping Dirichlet and Flux BCs and/or multiple DirichletBCs per sideset
ignore_zeros_in_jacobianFalseDo not explicitly store zero values in the Jacobian matrix if true
Default:False
C++ Type:bool
Options:
Description:Do not explicitly store zero values in the Jacobian matrix if true
kernel_coverage_checkTrueSet to false to disable kernel->subdomain coverage check
Default:True
C++ Type:bool
Options:
Description:Set to false to disable kernel->subdomain coverage check
material_coverage_checkTrueSet to false to disable material->subdomain coverage check
Default:True
C++ Type:bool
Options:
Description:Set to false to disable material->subdomain coverage check
material_dependency_checkTrueSet to false to disable material dependency check
Default:True
C++ Type:bool
Options:
Description:Set to false to disable material dependency check
near_null_space_dimension0The dimension of the near nullspace
Default:0
C++ Type:unsigned int
Options:
Description:The dimension of the near nullspace
negative_sign_eigen_kernelTrueWhether or not to use a negative sign for eigenvalue kernels. Using a negative sign makes eigenvalue kernels consistent with a nonlinear solver
Default:True
C++ Type:bool
Options:
Description:Whether or not to use a negative sign for eigenvalue kernels. Using a negative sign makes eigenvalue kernels consistent with a nonlinear solver
null_space_dimension0The dimension of the nullspace
Default:0
C++ Type:unsigned int
Options:
Description:The dimension of the nullspace
parallel_barrier_messagingFalseDisplays messaging from parallel barrier notifications when executing or transferring to/from Multiapps (default: false)
Default:False
C++ Type:bool
Options:
Description:Displays messaging from parallel barrier notifications when executing or transferring to/from Multiapps (default: false)
previous_nl_solution_requiredFalseTrue to indicate that this calculation requires a solution vector for storing the prvious nonlinear iteration.
Default:False
C++ Type:bool
Options:
Description:True to indicate that this calculation requires a solution vector for storing the prvious nonlinear iteration.
restart_file_baseFile base name used for restart (e.g. / or /LATEST to grab the latest file available)
C++ Type:FileNameNoExtension
Options:
Description:File base name used for restart (e.g. / or /LATEST to grab the latest file available)
rz_coord_axisYThe rotation axis (X | Y) for axisymetric coordinates
Default:Y
C++ Type:MooseEnum
Options:X, Y
Description:The rotation axis (X | Y) for axisymetric coordinates
skip_additional_restart_dataFalseTrue to skip additional data in equation system for restart. It is useful for starting a transient calculation with a steady-state solution
Default:False
C++ Type:bool
Options:
Description:True to skip additional data in equation system for restart. It is useful for starting a transient calculation with a steady-state solution
skip_nl_system_checkFalseTrue to skip the NonlinearSystem check for work to do (e.g. Make sure that there are variables to solve for).
Default:False
C++ Type:bool
Options:
Description:True to skip the NonlinearSystem check for work to do (e.g. Make sure that there are variables to solve for).
solveTrueWhether or not to actually solve the Nonlinear system. This is handy in the case that all you want to do is execute AuxKernels, Transfers, etc. without actually solving anything
Default:True
C++ Type:bool
Options:
Description:Whether or not to actually solve the Nonlinear system. This is handy in the case that all you want to do is execute AuxKernels, Transfers, etc. without actually solving anything
transpose_null_space_dimension0The dimension of the transpose nullspace
Default:0
C++ Type:unsigned int
Options:
Description:The dimension of the transpose nullspace
use_nonlinearTrueDetermines whether to use a Nonlinear vs a Eigenvalue system (Automatically determined based on executioner)
Default:True
C++ Type:bool
Options:
Description:Determines whether to use a Nonlinear vs a Eigenvalue system (Automatically determined based on executioner)

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
default_ghostingFalseWhether or not to use libMesh's default amount of algebraic and geometric ghosting
Default:False
C++ Type:bool
Options:
Description:Whether or not to use libMesh's default amount of algebraic and geometric ghosting
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Parameters