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

Detailed Description

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

Definition at line 46 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, PythonSourceTermData &&source_term_data, unsigned const integration_order, unsigned const shapefunction_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)
virtual	~SourceTerm ()=default

Private Attributes
PythonSourceTermData	_source_term_data
	Auxiliary data. More...
std::vector< std::unique_ptr< PythonSourceTermLocalAssemblerInterface > >	_local_assemblers
	Local assemblers for all elements of the source term mesh. More...
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, PythonSourceTermData &&  source_term_data, unsigned const  integration_order, unsigned const  shapefunction_order, unsigned const  global_dim, bool const  flush_stdout  )

explicit

Definition at line 29 of file PythonSourceTerm.cpp.

    : SourceTerm(std::move(source_term_dof_table)),
      _source_term_data(std::move(source_term_data)),
      _flush_stdout(flush_stdout)
{
    BoundaryConditionAndSourceTerm::createLocalAssemblers<
        PythonSourceTermLocalAssembler>(
        global_dim, _source_term_data.source_term_mesh.getElements(),
        *_source_term_dof_table, shapefunction_order, _local_assemblers,
        _source_term_data.source_term_mesh.isAxiallySymmetric(),
        integration_order, _source_term_data);
}

References _local_assemblers, _source_term_data, ProcessLib::SourceTerm::_source_term_dof_table, ProcessLib::BoundaryConditionAndSourceTerm::createLocalAssemblers(), MeshLib::Mesh::getElements(), MeshLib::Mesh::isAxiallySymmetric(), and ProcessLib::SourceTerms::Python::PythonSourceTermData::source_term_mesh.

Member Function Documentation

integrate()

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

overridevirtual

Implements ProcessLib::SourceTerm.

Definition at line 46 of file PythonSourceTerm.cpp.

{
    FlushStdoutGuard guard(_flush_stdout);
 
    GlobalExecutor::executeMemberOnDereferenced(
        &PythonSourceTermLocalAssemblerInterface::assemble, _local_assemblers,
        *_source_term_dof_table, t, x, b, Jac);
}

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

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 69 of file PythonSourceTerm.h.

Referenced by 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 64 of file PythonSourceTerm.h.

Referenced by PythonSourceTerm(), and integrate().

_source_term_data

PythonSourceTermData ProcessLib::SourceTerms::Python::PythonSourceTerm::_source_term_data

private

Auxiliary data.

Definition at line 60 of file PythonSourceTerm.h.

Referenced by PythonSourceTerm().

---

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

• ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTerm.h
• ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTerm.cpp