precice::action::SummationAction Class Reference

Action that adds multiple source data into target data. More...

#include <SummationAction.hpp>

Inheritance diagram for precice::action::SummationAction:

Collaboration diagram for precice::action::SummationAction:

Public Member Functions
	SummationAction (Timing timing, const std::vector< int > &sourceDataIDs, int targetDataID, const mesh::PtrMesh &mesh)
	Constructor.
void	performAction () final override
	Adding data and applying them to target.
Public Member Functions inherited from precice::action::Action
	Action (Timing timing, const mesh::PtrMesh &mesh, mapping::Mapping::MeshRequirement requirement)
	Action (Timing timing, const mesh::PtrMesh &mesh)
Action &	operator= (Action &&)=delete
virtual	~Action ()=default
	Destructor, empty.
Timing	getTiming () const
	Returns the timing of the action.
const mesh::PtrMesh &	getMesh () const
	Returns the mesh carrying the data used in the action.
mapping::Mapping::MeshRequirement	getMeshRequirement () const
	Returns the mesh requirement of this action.

Private Attributes
logging::Logger	_log {"action::SummationAction"}
mesh::PtrData	_targetData
std::vector< mesh::PtrData >	_sourceDataVector

Additional Inherited Members
Public Types inherited from precice::action::Action
enum	Timing { WRITE_MAPPING_POST , READ_MAPPING_POST }
	Defines the time and place of application of the action. More...

Detailed Description

Action that adds multiple source data into target data.

Definition at line 12 of file SummationAction.hpp.

Constructor & Destructor Documentation

SummationAction()

precice::action::SummationAction::SummationAction	(	Timing	timing,
		const std::vector< int > &	sourceDataIDs,
		int	targetDataID,
		const mesh::PtrMesh &	mesh )

Constructor.

Parameters

[in]	Timing	When to apply the action
[in]	sourceDataIDs	Data indexes which are to be added
[in]	targetDataID	Data in which the action will be applied

Definition at line 13 of file SummationAction.cpp.

Here is the call graph for this function:

Member Function Documentation

performAction()

void precice::action::SummationAction::performAction ( )

finaloverridevirtual

Adding data and applying them to target.

Implements precice::action::Action.

Definition at line 30 of file SummationAction.cpp.

Here is the call graph for this function:

Member Data Documentation

_log

logging::Logger precice::action::SummationAction::_log {"action::SummationAction"}

private

Definition at line 32 of file SummationAction.hpp.

_sourceDataVector

std::vector<mesh::PtrData> precice::action::SummationAction::_sourceDataVector

private

Definition at line 35 of file SummationAction.hpp.

_targetData

mesh::PtrData precice::action::SummationAction::_targetData

private

Definition at line 34 of file SummationAction.hpp.

---

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

• src/action/SummationAction.hpp
• src/action/SummationAction.cpp