ProcessLib::SourceTerms::Python::PythonSourceTerm Class Reference

Detailed Description

A source term whose values are computed by a Python script.

Definition at line 37 of file PythonSourceTerm.h.

#include <PythonSourceTerm.h>

Inheritance diagram for ProcessLib::SourceTerms::Python::PythonSourceTerm:

Collaboration diagram for ProcessLib::SourceTerms::Python::PythonSourceTerm:

Public Member Functions
	PythonSourceTerm (std::unique_ptr< NumLib::LocalToGlobalIndexMap > source_term_dof_table, PythonStData &&source_term_data, unsigned const integration_order, unsigned const global_dim, bool const flush_stdout)
void	integrate (const double t, GlobalVector const &x, GlobalVector &b, GlobalMatrix *jac) const override
Public Member Functions inherited from ProcessLib::SourceTerm
	SourceTerm (std::unique_ptr< NumLib::LocalToGlobalIndexMap > source_term_dof_table)
Public Member Functions inherited from ProcessLib::SourceTermBase
virtual	~SourceTermBase ()=default

Private Attributes
PythonStData	_source_term_data
	Auxiliary data used by the local assemblers.
std::vector< std::unique_ptr< PythonSourceTermLocalAssemblerInterface > >	_local_assemblers
	Local assemblers for all elements of the source term mesh.
bool const	_flush_stdout

Additional Inherited Members
Protected Attributes inherited from ProcessLib::SourceTerm
std::unique_ptr< NumLib::LocalToGlobalIndexMap > const	_source_term_dof_table

Constructor & Destructor Documentation

PythonSourceTerm()

ProcessLib::SourceTerms::Python::PythonSourceTerm::PythonSourceTerm ( std::unique_ptr< NumLib::LocalToGlobalIndexMap > source_term_dof_table, PythonStData && source_term_data, unsigned const integration_order, unsigned const global_dim, bool const flush_stdout )

explicit

Definition at line 23 of file PythonSourceTerm.cpp.

    : SourceTerm(std::move(source_term_dof_table)),
      _source_term_data(std::move(source_term_data)),
      _flush_stdout(flush_stdout)
{
    BoundaryConditionAndSourceTerm::createLocalAssemblersPython<
        PythonSourceTermLocalAssembler>(
        global_dim, _source_term_data.bc_or_st_mesh.getElements(),
        *_source_term_dof_table, _local_assemblers,
        NumLib::IntegrationOrder{integration_order},
        _source_term_data.bc_or_st_mesh.isAxiallySymmetric(),
        _source_term_data);
}

References ProcessLib::SourceTerm::SourceTerm(), _flush_stdout, _local_assemblers, _source_term_data, ProcessLib::SourceTerm::_source_term_dof_table, and ProcessLib::BoundaryConditionAndSourceTerm::createLocalAssemblersPython().

Member Function Documentation

integrate()

void ProcessLib::SourceTerms::Python::PythonSourceTerm::integrate ( const double t, GlobalVector const & x, GlobalVector & b, GlobalMatrix * jac ) const

overridevirtual

Implements ProcessLib::SourceTermBase.

Definition at line 40 of file PythonSourceTerm.cpp.

{
    FlushStdoutGuard guard(_flush_stdout);
 
    try
    {
        GlobalExecutor::executeMemberOnDereferenced(
            &PythonSourceTermLocalAssemblerInterface::assemble,
            _local_assemblers, *_source_term_dof_table, t, x, b, Jac);
    }
    catch (pybind11::error_already_set const& e)
    {
        OGS_FATAL("Error evaluating source term in Python: {}", e.what());
    }
}

References _flush_stdout, _local_assemblers, ProcessLib::SourceTerm::_source_term_dof_table, ProcessLib::SourceTerms::Python::PythonSourceTermLocalAssemblerInterface::assemble(), NumLib::SerialExecutor::executeMemberOnDereferenced(), and OGS_FATAL.

Member Data Documentation

_flush_stdout

bool const ProcessLib::SourceTerms::Python::PythonSourceTerm::_flush_stdout

private

Whether or not to flush standard output before and after each call to Python code. Ensures right order of output messages and therefore simplifies debugging.

Definition at line 59 of file PythonSourceTerm.h.

Referenced by PythonSourceTerm(), and integrate().

_local_assemblers

std::vector<std::unique_ptr<PythonSourceTermLocalAssemblerInterface> > ProcessLib::SourceTerms::Python::PythonSourceTerm::_local_assemblers

private

Local assemblers for all elements of the source term mesh.

Definition at line 54 of file PythonSourceTerm.h.

Referenced by PythonSourceTerm(), and integrate().

_source_term_data

PythonStData ProcessLib::SourceTerms::Python::PythonSourceTerm::_source_term_data

private

Auxiliary data used by the local assemblers.

Definition at line 50 of file PythonSourceTerm.h.

Referenced by PythonSourceTerm().

---

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

• PythonSourceTerm.h
• PythonSourceTerm.cpp