https://mooseframework.inl.gov
Public Member Functions | Public Attributes | List of all members
Moose::PetscSupport::PetscOptions Class Reference

A struct for storing the various types of petsc options and values. More...

#include <PetscSupport.h>

Public Member Functions

 PetscOptions ()
 

Public Attributes

std::vector< std::pair< std::string, std::string > > pairs
 PETSc key-value pairs. More...
 
MultiMooseEnum flags
 Single value PETSc options (flags) More...
 
MultiMooseEnum dont_add_these_options
 Flags to explicitly not set, even if they are specified programmatically. More...
 
MultiMooseEnum user_set_options
 Options that are set by the user at the input level. More...
 
std::string pc_description
 Preconditioner description. More...
 

Detailed Description

A struct for storing the various types of petsc options and values.

Definition at line 39 of file PetscSupport.h.

Constructor & Destructor Documentation

◆ PetscOptions()

Moose::PetscSupport::PetscOptions::PetscOptions ( )
inline

Definition at line 42 of file PetscSupport.h.

43  : flags("", "", true), dont_add_these_options("", "", true), user_set_options("", "", true)
44  {
45  }
MultiMooseEnum flags
Single value PETSc options (flags)
Definition: PetscSupport.h:51
MultiMooseEnum dont_add_these_options
Flags to explicitly not set, even if they are specified programmatically.
Definition: PetscSupport.h:54
MultiMooseEnum user_set_options
Options that are set by the user at the input level.
Definition: PetscSupport.h:57

Member Data Documentation

◆ dont_add_these_options

MultiMooseEnum Moose::PetscSupport::PetscOptions::dont_add_these_options

◆ flags

MultiMooseEnum Moose::PetscSupport::PetscOptions::flags

Single value PETSc options (flags)

Definition at line 51 of file PetscSupport.h.

Referenced by Moose::PetscSupport::addPetscFlagsToPetscOptions(), and Moose::PetscSupport::petscSetOptionsHelper().

◆ pairs

std::vector<std::pair<std::string, std::string> > Moose::PetscSupport::PetscOptions::pairs

◆ pc_description

std::string Moose::PetscSupport::PetscOptions::pc_description

Preconditioner description.

Definition at line 60 of file PetscSupport.h.

Referenced by Moose::PetscSupport::addPetscPairsToPetscOptions(), and ConsoleUtils::outputExecutionInformation().

◆ user_set_options

MultiMooseEnum Moose::PetscSupport::PetscOptions::user_set_options

Options that are set by the user at the input level.

Definition at line 57 of file PetscSupport.h.

Referenced by Moose::PetscSupport::addPetscFlagsToPetscOptions(), Moose::PetscSupport::addPetscPairsToPetscOptions(), and Moose::PetscSupport::petscSetOptionsHelper().


The documentation for this class was generated from the following file: