doxygen/moose/MatrixSymmetryCheck_8h_source.html

//* This file is part of the MOOSE framework

//* https://mooseframework.inl.gov

//*

//* All rights reserved, see COPYRIGHT for full restrictions

//* https://github.com/idaholab/moose/blob/master/COPYRIGHT

//*

//* Licensed under LGPL 2.1, please see LICENSE for details

//* https://www.gnu.org/licenses/lgpl-2.1.html


#pragma once


#include "GeneralPostprocessor.h"


class MatrixSymmetryCheck : public GeneralPostprocessor

{

public:

  static InputParameters validParams();


  MatrixSymmetryCheck(const InputParameters & parameters);


  virtual void initialize() override {}

  virtual void execute() override;

  virtual Real getValue() const override;


protected:

  const bool _mat_from_file;

  const std::string _mat_file_name;

  const Real _symm_tol;

  const unsigned int _mat_number_to_load;

  bool _equiv;

};


GeneralPostprocessor.h

GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition GeneralPostprocessor.h:22

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

MatrixSymmetryCheck
Checks whether the nonlinear system matrix is symmetric.
Definition MatrixSymmetryCheck.h:18

MatrixSymmetryCheck::validParams
static InputParameters validParams()
Definition MatrixSymmetryCheck.C:24

MatrixSymmetryCheck::_symm_tol
const Real _symm_tol
Tolerance for the comparison between coefficients and transpose counterparts.
Definition MatrixSymmetryCheck.h:34

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_number_to_load
const unsigned int _mat_number_to_load
A binary file may contain multiple writes of a matrix.
Definition MatrixSymmetryCheck.h:37

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::_equiv
bool _equiv
Whether the matrix is symmetric.
Definition MatrixSymmetryCheck.h:39

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::execute
virtual void execute() override
Execute method.
Definition MatrixSymmetryCheck.C:55

MooseBase::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131