ProcessLib::Assembly::LocalMatrixOutput Struct Reference

Detailed Description

Writes local matrices to disk for debugging purposes.

Definition at line 37 of file MatrixOutput.h.

#include <MatrixOutput.h>

Public Member Functions
	LocalMatrixOutput ()
void	operator() (double const t, int const process_id, std::size_t const element_id, std::vector< double > const &local_M_data, std::vector< double > const &local_K_data, std::vector< double > const &local_b_data)
void	operator() (double const t, int const process_id, std::size_t const element_id, std::vector< double > const &local_b_data, std::vector< double > const &local_Jac_data)
	~LocalMatrixOutput ()

Private Member Functions
bool	isOutputRequested (std::size_t const element_id) const

Private Attributes
std::mutex	mutex_
std::ofstream	outputFile_
std::function< bool(std::size_t)>	output_element_predicate_

Constructor & Destructor Documentation

LocalMatrixOutput()

ProcessLib::Assembly::LocalMatrixOutput::LocalMatrixOutput

(

)

Definition at line 254 of file MatrixOutput.cpp.

{
    auto const opt_prefix = getEnvironmentVariable("OGS_LOCAL_MAT_OUT_PREFIX");
    auto const opt_elements =
        getEnvironmentVariable("OGS_LOCAL_MAT_OUT_ELEMENTS");
 
    if (!opt_prefix)
    {
        if (opt_elements)
        {
            WARN(
                "Environment variable OGS_LOCAL_MAT_OUT_ELEMENTS is set, but "
                "OGS_LOCAL_MAT_OUT_PREFIX is not. Local matrix debug output "
                "will be disabled.");
        }
 
        return;
    }
    if (!opt_elements)
    {
        WARN(
            "Environment variable OGS_LOCAL_MAT_OUT_PREFIX is set, but "
            "OGS_LOCAL_MAT_OUT_ELEMENTS is not. Local matrix debug output "
            "will be disabled.");
        return;
    }
 
    output_element_predicate_ =
        detail::createLocalMatrixOutputElementPredicate(*opt_elements);
 
    if (!output_element_predicate_)
    {
        WARN(
            "Environment variable OGS_LOCAL_MAT_OUT_ELEMENTS not set "
            "properly. Local matrix debug output will be disabled.");
        return;
    }
 
    auto const outputFilename = localMatrixOutputFilename(*opt_prefix);
    outputFile_.open(outputFilename);
 
    if (!outputFile_)
    {
        OGS_FATAL(
            "File `{}' for local matrix debug output could not be "
            "opened.",
            outputFilename);
    }
 
    DBUG("Successfully opened local matrix debug output file {}.",
         outputFilename);
}

References ProcessLib::Assembly::detail::createLocalMatrixOutputElementPredicate(), DBUG(), OGS_FATAL, output_element_predicate_, outputFile_, and WARN().

~LocalMatrixOutput()

ProcessLib::Assembly::LocalMatrixOutput::~LocalMatrixOutput ( )

default

Member Function Documentation

isOutputRequested()

bool ProcessLib::Assembly::LocalMatrixOutput::isOutputRequested ( std::size_t const element_id ) const

private

Definition at line 381 of file MatrixOutput.cpp.

{
    return output_element_predicate_ && output_element_predicate_(element_id);
}

References output_element_predicate_.

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

operator()() [1/2]

void ProcessLib::Assembly::LocalMatrixOutput::operator()	(	double const	t,
		int const	process_id,
		std::size_t const	element_id,
		std::vector< double > const &	local_b_data,
		std::vector< double > const &	local_Jac_data )

Definition at line 347 of file MatrixOutput.cpp.

{
    [[likely]] if (!isOutputRequested(element_id))
    {
        return;
    }
 
    std::lock_guard lock_guard{mutex_};
 
    auto& fh = outputFile_;
 
    DBUG("Writing to local matrix debug output file...");
 
    fmt::print(fh, "## t = {:.{}g}, process id = {}, element id = {}\n\n", t,
               std::numeric_limits<double>::max_digits10, process_id,
               element_id);
 
    if (!local_b_data.empty())
    {
        DBUG("... b");
        fmt::print(fh, "# b\n{}\n\n", MathLib::toVector(local_b_data));
    }
 
    if (!local_Jac_data.empty())
    {
        DBUG("... Jac");
        fmt::print(fh, "# Jac\n{}\n\n\n",
                   toSquareMatrixRowMajor(local_Jac_data));
    }
}

References DBUG(), isOutputRequested(), mutex_, outputFile_, and MathLib::toVector().

operator()() [2/2]

void ProcessLib::Assembly::LocalMatrixOutput::operator()	(	double const	t,
		int const	process_id,
		std::size_t const	element_id,
		std::vector< double > const &	local_M_data,
		std::vector< double > const &	local_K_data,
		std::vector< double > const &	local_b_data )

Definition at line 307 of file MatrixOutput.cpp.

{
    [[likely]] if (!isOutputRequested(element_id))
    {
        return;
    }
 
    std::lock_guard lock_guard{mutex_};
 
    auto& fh = outputFile_;
 
    DBUG("Writing to local matrix debug output file...");
 
    fmt::print(fh, "## t = {:.{}g}, process id = {}, element id = {}\n\n", t,
               std::numeric_limits<double>::max_digits10, process_id,
               element_id);
 
    if (!local_M_data.empty())
    {
        DBUG("... M");
        fmt::print(fh, "# M\n{}\n\n", toSquareMatrixRowMajor(local_M_data));
    }
 
    if (!local_K_data.empty())
    {
        DBUG("... K");
        fmt::print(fh, "# K\n{}\n\n", toSquareMatrixRowMajor(local_K_data));
    }
 
    if (!local_b_data.empty())
    {
        DBUG("... b");
        fmt::print(fh, "# b\n{}\n\n", MathLib::toVector(local_b_data));
    }
}

References DBUG(), isOutputRequested(), mutex_, outputFile_, and MathLib::toVector().

Member Data Documentation

mutex_

std::mutex ProcessLib::Assembly::LocalMatrixOutput::mutex_

private

Definition at line 57 of file MatrixOutput.h.

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

output_element_predicate_

std::function<bool(std::size_t)> ProcessLib::Assembly::LocalMatrixOutput::output_element_predicate_

private

Definition at line 59 of file MatrixOutput.h.

Referenced by LocalMatrixOutput(), and isOutputRequested().

outputFile_

std::ofstream ProcessLib::Assembly::LocalMatrixOutput::outputFile_

private

Definition at line 58 of file MatrixOutput.h.

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

---

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

• MatrixOutput.h
• MatrixOutput.cpp