Module is an executable block class capable of computing the magnitude field of a vector field. More...

#include <Module.hpp>

Inheritance diagram for mimmo::Module:

Collaboration diagram for mimmo::Module:

[legend]

Public Member Functions
	Module ()

	Module (const bitpit::Config::Section &rootXML)

	Module (const Module &other)

virtual	~Module ()

virtual void	absorbSectionXML (const bitpit::Config::Section &slotXML, std::string name="")

void	buildPorts ()

void	clear ()

void	execute ()

virtual void	flushSectionXML (bitpit::Config::Section &slotXML, std::string name="")

dmpvector1D *	getResult ()

Module &	operator= (Module other)

void	plotOptionalResults ()

void	setField (dmpvecarr3E *field)

Public Member Functions inherited from mimmo::BaseManipulation
	BaseManipulation ()

	BaseManipulation (const BaseManipulation &other)

virtual	~BaseManipulation ()

void	activate ()

bool	arePortsBuilt ()

void	clear ()

void	disable ()

void	exec ()

BaseManipulation *	getChild (int i=0)

ConnectionType	getConnectionType ()

MimmoSharedPointer< MimmoObject >	getGeometry ()

MimmoSharedPointer< MimmoObject > &	getGeometryReference ()

int	getId ()

bitpit::Logger &	getLog ()

std::string	getName ()

int	getNChild ()

int	getNParent ()

int	getNPortsIn ()

int	getNPortsOut ()

BaseManipulation *	getParent (int i=0)

std::unordered_map< PortID, PortIn * >	getPortsIn ()

std::unordered_map< PortID, PortOut * >	getPortsOut ()

uint	getPriority ()

virtual std::vector< BaseManipulation * >	getSubBlocksEmbedded ()

bool	isActive ()

bool	isApply ()

bool	isChild (BaseManipulation *, int &)

bool	isParent (BaseManipulation *, int &)

bool	isPlotInExecution ()

BaseManipulation &	operator= (const BaseManipulation &other)

void	removePins ()

void	removePinsIn ()

void	removePinsOut ()

void	setApply (bool flag=true)

void	setGeometry (MimmoSharedPointer< MimmoObject > geometry)

void	setId (int)

void	setLog (bitpit::Logger &log)

void	setName (std::string name)

void	setOutputPlot (std::string path)

void	setPlotInExecution (bool)

void	setPriority (uint priority)

void	unsetGeometry ()

Protected Member Functions
void	swap (Module &x) noexcept

Protected Member Functions inherited from mimmo::BaseManipulation
void	_apply (MimmoPiercedVector< darray3E > &displacements)

void	addChild (BaseManipulation *child)

void	addParent (BaseManipulation *parent)

void	addPinIn (BaseManipulation *objIn, PortID portR)

void	addPinOut (BaseManipulation *objOut, PortID portS, PortID portR)

virtual void	apply ()

void	cleanBufferIn (PortID port)

template<typename T , typename O >
bool	createPortIn (O obj, void(O::setVar_)(T), PortID portR, bool mandatory=false, int family=0)

template<typename T , typename O >
bool	createPortIn (T *var_, PortID portR, bool mandatory=false, int family=0)

template<typename T , typename O >
bool	createPortOut (O obj, T(O::getVar_)(), PortID portS)

template<typename T , typename O >
bool	createPortOut (T *var_, PortID portS)

void	deletePorts ()

PortID	findPinIn (PortIn &pin)

PortID	findPinOut (PortOut &pin)

void	initializeLogger (bool logexists)

void	readBufferIn (PortID port)

void	removePinIn (BaseManipulation *objIn, PortID portR)

void	removePinIn (PortID portR, int j)

void	removePinOut (BaseManipulation *objOut, PortID portS)

void	removePinOut (PortID portS, int j)

void	setBufferIn (PortID port, mimmo::IBinaryStream &input)

void	swap (BaseManipulation &x) noexcept

void	unsetChild (BaseManipulation *child)

void	unsetParent (BaseManipulation *parent)

void	write (MimmoSharedPointer< MimmoObject > geometry)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, MimmoPiercedVector< mpv_t > &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, MimmoPiercedVector< mpv_t > &data, Args ... args)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t > * > &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t > * > &data, Args ... args)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t >> &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t >> &data, Args ... args)

Protected Attributes
dmpvecarr3E	m_field

dmpvector1D	m_result

Protected Attributes inherited from mimmo::BaseManipulation
bool	m_active

bool	m_apply

bool	m_arePortsBuilt

bmumap	m_child

int	m_counter

bool	m_execPlot

MimmoSharedPointer< MimmoObject >	m_geometry

bitpit::Logger *	m_log

std::string	m_name

std::string	m_outputPlot

bmumap	m_parent

std::unordered_map< PortID, PortIn * >	m_portIn

std::unordered_map< PortID, PortOut * >	m_portOut

ConnectionType	m_portsType

uint	m_priority

Additional Inherited Members
Public Types inherited from mimmo::BaseManipulation
typedef std::unordered_map< BaseManipulation *, int >	bmumap

typedef pin::ConnectionType	ConnectionType

typedef std::string	PortID

Static Protected Attributes inherited from mimmo::BaseManipulation
static int	sm_baseManipulationCounter

Detailed Description

Module is an executable block class capable of computing the magnitude field of a vector field.

Module takes as input a vector field with any data location (POINT, CELLS or INTERFACES), computes its magnitude and it gives the scalar field as result.

Ports available in Module Class :

Port Input
PortType	variable/function	DataType
M_VECTORFIELD	setField	(MC_SCALAR, MD_MPVECARR3FLOAT_)

Port Output
PortType	variable/function	DataType
M_SCALARFIELD	getResult	(MC_SCALAR, MD_MPVECFLOAT_)

The xml available parameters, sections and subsections are the following :

Inherited from BaseManipulation:

ClassName: name of the class as mimmo.Module;
Priority: uint marking priority in multi-chain execution;
PlotInExecution: boolean 0/1 print optional results of the class.
OutputPlot: target directory for optional results writing.

Definition at line 66 of file Module.hpp.

Constructor & Destructor Documentation

◆ Module() [1/3]

mimmo::Module::Module ( )

Default constructor of Module.

Definition at line 31 of file Module.cpp.

◆ Module() [2/3]

mimmo::Module::Module ( const bitpit::Config::Section & rootXML )

Custom constructor reading xml data

Parameters

[in] rootXML reference to your xml tree section

Definition at line 39 of file Module.cpp.

◆ ~Module()

mimmo::Module::~Module ( )

virtual

Default destructor of Module.

Definition at line 57 of file Module.cpp.

◆ Module() [3/3]

mimmo::Module::Module ( const Module & other )

Copy Constructor.

Parameters

[in] other class of type Module

Definition at line 63 of file Module.cpp.

Member Function Documentation

◆ absorbSectionXML()

void mimmo::Module::absorbSectionXML	(	const bitpit::Config::Section &	slotXML,
		std::string	name = `""`
	)

virtual

It sets infos reading from a XML bitpit::Config::section.

Parameters

[in]	slotXML	bitpit::Config::Section of XML file
[in]	name	name associated to the slot

Reimplemented from mimmo::BaseManipulation.

Definition at line 163 of file Module.cpp.

◆ buildPorts()

void mimmo::Module::buildPorts ( )

virtual

Build the ports of the class;

Implements mimmo::BaseManipulation.

Definition at line 92 of file Module.cpp.

◆ clear()

void mimmo::Module::clear ( )

Clear all stuffs in your class

Definition at line 103 of file Module.cpp.

◆ execute()

void mimmo::Module::execute ( )

virtual

Execution command. Compute the module field of an input vector field.

Implements mimmo::BaseManipulation.

Definition at line 132 of file Module.cpp.

◆ flushSectionXML()

void mimmo::Module::flushSectionXML	(	bitpit::Config::Section &	slotXML,
		std::string	name = `""`
	)

virtual

It sets infos from class members in a XML bitpit::Config::section.

Parameters

[in]	slotXML	bitpit::Config::Section of XML file
[in]	name	name associated to the slot

Reimplemented from mimmo::BaseManipulation.

Definition at line 175 of file Module.cpp.

◆ getResult()

dmpvector1D * mimmo::Module::getResult ( )

Get resulting scalar field.

Returns: magnitude field

Definition at line 124 of file Module.cpp.

◆ operator=()

Module & mimmo::Module::operator= ( Module other )

Assignement operator of Module.

Parameters

[in] other class of type Module

Definition at line 83 of file Module.cpp.

◆ plotOptionalResults()

void mimmo::Module::plotOptionalResults ( )

virtual

Plot computed field over the linked geometry

Reimplemented from mimmo::BaseManipulation.

Definition at line 151 of file Module.cpp.

◆ setField()

void mimmo::Module::setField ( dmpvecarr3E * field )

Set input field for computing.

Parameters

[in] field input field

Definition at line 114 of file Module.cpp.

◆ swap()

void mimmo::Module::swap ( Module & x )

protectednoexcept

Swap function of Module

Parameters

[in] x object to be swapped.

Definition at line 72 of file Module.cpp.

Member Data Documentation

◆ m_field

dmpvecarr3E mimmo::Module::m_field

protected

Input field to be extract.

Definition at line 68 of file Module.hpp.

◆ m_result

dmpvector1D mimmo::Module::m_result

protected

Result extract field.

Definition at line 69 of file Module.hpp.

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

src/core/Module.hpp
src/core/Module.cpp

Our website uses cookies

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Module() [1/3]

◆ Module() [2/3]

◆ ~Module()

◆ Module() [3/3]

Member Function Documentation

◆ absorbSectionXML()

◆ buildPorts()

◆ clear()

◆ execute()

◆ flushSectionXML()

◆ getResult()

◆ operator=()

◆ plotOptionalResults()

◆ setField()

◆ swap()

Member Data Documentation

◆ m_field

◆ m_result