ProcessLib::Assembly::GlobalMatrixOutput Struct Reference

Detailed Description

Writes global matrices to disk for debugging purposes.

Definition at line 23 of file MatrixOutput.h.

#include <MatrixOutput.h>

Public Member Functions
	GlobalMatrixOutput ()
void	operator() (double const t, int const process_id, GlobalMatrix const &M, GlobalMatrix const &K, GlobalVector const &b, GlobalMatrix const *const Jac=nullptr)

Private Attributes
std::string	filenamePrefix_
std::size_t	counter_ = 0
bool	do_output_ = false

Constructor & Destructor Documentation

GlobalMatrixOutput()

ProcessLib::Assembly::GlobalMatrixOutput::GlobalMatrixOutput

(

)

Definition at line 159 of file MatrixOutput.cpp.

{
    auto opt_prefix = getEnvironmentVariable("OGS_GLOBAL_MAT_OUT_PREFIX");
 
    if (opt_prefix.has_value())
    {
#ifndef USE_PETSC
        do_output_ = true;
        filenamePrefix_ = std::move(*opt_prefix);
#else
        // TODO implement. PETScMatrix's viewer() method could be used for that.
        WARN(
            "You requested global matrix output (OGS_GLOBAL_MAT_OUT_PREFIX is "
            "set), which is not yet implemented for PETSc matrices.");
#endif
    }
}

References do_output_, filenamePrefix_, and WARN().

Member Function Documentation

operator()()

void ProcessLib::Assembly::GlobalMatrixOutput::operator()	(	double const	t,
		int const	process_id,
		GlobalMatrix const &	M,
		GlobalMatrix const &	K,
		GlobalVector const &	b,
		GlobalMatrix const *const	Jac = nullptr )

Definition at line 177 of file MatrixOutput.cpp.

{
    if (!do_output_)
    {
        return;
    }
 
#ifndef USE_PETSC
    ++counter_;
 
    {
        auto fh = openGlobalMatrixOutputFile(filenamePrefix_, counter_, t,
                                             process_id, "M", "mat");
 
        fh << "M ";
        outputGlobalMatrix(M, fh);
    }
 
    {
        auto fh = openGlobalMatrixOutputFile(filenamePrefix_, counter_, t,
                                             process_id, "K", "mat");
 
        fh << "K ";
        outputGlobalMatrix(K, fh);
    }
 
    {
        auto fh = openGlobalMatrixOutputFile(filenamePrefix_, counter_, t,
                                             process_id, "b", "vec");
 
        fh << "b ";
        outputGlobalVector(b, fh);
    }
 
    if (Jac)
    {
        auto fh = openGlobalMatrixOutputFile(filenamePrefix_, counter_, t,
                                             process_id, "Jac", "mat");
 
        fh << "Jac ";
        outputGlobalMatrix(*Jac, fh);
    }
#else
    // do nothing, warning message already printed in the constructor
    (void)t;
    (void)process_id;
    (void)M;
    (void)K;
    (void)b;
    (void)Jac;
#endif
}

References counter_, do_output_, and filenamePrefix_.

Member Data Documentation

counter_

std::size_t ProcessLib::Assembly::GlobalMatrixOutput::counter_ = 0

private

Used to distinguish output files of global matrices at the same time, but, e.g., at different non-linear iterations etc.

Definition at line 36 of file MatrixOutput.h.

Referenced by operator()().

do_output_

bool ProcessLib::Assembly::GlobalMatrixOutput::do_output_ = false

private

Definition at line 38 of file MatrixOutput.h.

Referenced by GlobalMatrixOutput(), and operator()().

filenamePrefix_

std::string ProcessLib::Assembly::GlobalMatrixOutput::filenamePrefix_

private

Definition at line 32 of file MatrixOutput.h.

Referenced by GlobalMatrixOutput(), and operator()().

---

The documentation for this struct was generated from the following files:

• ProcessLib/Assembly/MatrixOutput.h
• ProcessLib/Assembly/MatrixOutput.cpp