https://mooseframework.inl.gov
include
postprocessors
MatrixSymmetryCheck.h
Go to the documentation of this file.
1
//* This file is part of the MOOSE framework
2
//* https://mooseframework.inl.gov
3
//*
4
//* All rights reserved, see COPYRIGHT for full restrictions
5
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6
//*
7
//* Licensed under LGPL 2.1, please see LICENSE for details
8
//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10
#pragma once
11
12
#include "
GeneralPostprocessor.h
"
13
17
class
MatrixSymmetryCheck
:
public
GeneralPostprocessor
18
{
19
public
:
20
static
InputParameters
validParams
();
21
22
MatrixSymmetryCheck
(
const
InputParameters
&
parameters
);
23
24
virtual
void
initialize
()
override
{}
25
virtual
void
execute
()
override
;
26
virtual
Real
getValue
()
const override
;
27
28
protected
:
30
const
bool
_mat_from_file
;
32
const
std::string
_mat_file_name
;
34
const
Real
_symm_tol
;
37
const
unsigned
int
_mat_number_to_load
;
39
bool
_equiv
;
40
};
MatrixSymmetryCheck::_equiv
bool _equiv
Whether the matrix is symmetric.
Definition:
MatrixSymmetryCheck.h:39
MatrixSymmetryCheck::_mat_number_to_load
const unsigned int _mat_number_to_load
A binary file may contain multiple writes of a matrix.
Definition:
MatrixSymmetryCheck.h:37
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
MatrixSymmetryCheck::getValue
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition:
MatrixSymmetryCheck.C:98
MatrixSymmetryCheck::execute
virtual void execute() override
Execute method.
Definition:
MatrixSymmetryCheck.C:55
MatrixSymmetryCheck::MatrixSymmetryCheck
MatrixSymmetryCheck(const InputParameters ¶meters)
Definition:
MatrixSymmetryCheck.C:41
MatrixSymmetryCheck::_mat_from_file
const bool _mat_from_file
Whether the matrix we are checking for symmetry is from a file.
Definition:
MatrixSymmetryCheck.h:30
MatrixSymmetryCheck::_mat_file_name
const std::string _mat_file_name
The matrix from file name. Empty string if _mat_from_file is false.
Definition:
MatrixSymmetryCheck.h:32
MatrixSymmetryCheck::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
MatrixSymmetryCheck.h:24
MatrixSymmetryCheck
Checks whether the nonlinear system matrix is symmetric.
Definition:
MatrixSymmetryCheck.h:17
MatrixSymmetryCheck::_symm_tol
const Real _symm_tol
Tolerance for the comparison between coefficients and transpose counterparts.
Definition:
MatrixSymmetryCheck.h:34
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralPostprocessor.h
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
MatrixSymmetryCheck::validParams
static InputParameters validParams()
Definition:
MatrixSymmetryCheck.C:24
Generated on Wed Jul 16 2025 13:56:05 for https://mooseframework.inl.gov by
1.8.14