EigenProblem

under construction:Undocumented Class

The EigenProblem has not been documented. The content contained on this page 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.

!syntax description /Problem/EigenProblem

Input Parameters

  • 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

  • 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)

  • 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

  • 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)

  • 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

  • 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

  • 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

    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.

  • 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

  • null_space_dimension0The dimension of the nullspace

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The dimension of the nullspace

  • 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_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).

  • 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

  • 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

  • parallel_barrier_messagingTrueDisplays messaging from parallel barrier notifications when executing or transferring to/from Multiapps (default: true)

    Default:True

    C++ Type:bool

    Options:

    Description:Displays messaging from parallel barrier notifications when executing or transferring to/from Multiapps (default: true)

  • transpose_null_space_dimension0The dimension of the transpose nullspace

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The dimension of the transpose nullspace

  • near_null_space_dimension0The dimension of the near nullspace

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The dimension of the near nullspace

  • 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

    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.

  • 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

  • blockBlock IDs for the coordinate systems

    C++ Type:std::vector

    Options:

    Description:Block IDs for the coordinate systems

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References