SelectScalarField is specialized derived class of SelectField to Select a scalar field. More...

#include <SelectField.hpp>

Inheritance diagram for mimmo::SelectScalarField:

Collaboration diagram for mimmo::SelectScalarField:

[legend]

Public Member Functions
	SelectScalarField (const bitpit::Config::Section &rootXMl)

	SelectScalarField (const SelectScalarField &other)

	SelectScalarField (MPVLocation loc=MPVLocation::POINT)

virtual	~SelectScalarField ()

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

void	addField (dmpvector1D *field)

void	buildPorts ()

void	clear ()

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

dmpvector1D *	getSelectedField ()

void	plotOptionalResults ()

void	setFields (std::vector< dmpvector1D * > fields)

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

	SelectField (const SelectField &other)

virtual	~SelectField ()

void	clear ()

void	execute ()

std::string	getFieldName ()

void	setFieldName (std::string fieldname)

void	setMode (int mode)

void	setMode (SelectType mode)

void	setTolerance (double tol)

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 (SelectScalarField &) noexcept

Protected Member Functions inherited from mimmo::SelectField
void	swap (SelectField &) 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)

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

typedef pin::ConnectionType	ConnectionType

typedef std::string	PortID

Protected Attributes inherited from mimmo::SelectField
std::string	m_fieldname

SelectType	m_mode

double	m_tol

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

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

Detailed Description

SelectScalarField is specialized derived class of SelectField to Select a scalar field.

Ports available in SelectScalarField Class :

Port Input
PortType	variable/function	DataType
M_VECSCALARFIELDS	setFields	(MC_VECTOR, MD_MPVECFLOAT_)
M_SCALARFIELD	addField	(MC_SCALAR, MD_MPVECFLOAT_)

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

Inherited from SelectField

Port Input
PortType	variable/function	DataType
M_GEOM	setGeometry	(MC_SCALAR, MD_MIMMO_)
M_NAME	setName	(MC_SCALAR, MD_STRING)

Port Output
PortType	variable/function	DataType
M_GEOM	getGeometry	(MC_SCALAR, MD_MIMMO_)

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

Inherited from BaseManipulation:

ClassName: name of the class as mimmo.SelectScalarField
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.

Inherited from SelectField:

SelectType: selection method. Default SelectType::NAME.
Tolerance: double > 0, set tolerance of mapping. The option is ignored if mapping is not active.
FieldName: name of the field to be selected. Default "data".

Proper of the class:

Location set unique data location for all fields 1-POINT, 2-CELL, 3-INTERFACE.

Fields have to be mandatorily passed through port.

Definition at line 192 of file SelectField.hpp.

Constructor & Destructor Documentation

◆ SelectScalarField() [1/3]

mimmo::SelectScalarField::SelectScalarField ( MPVLocation loc = MPVLocation::POINT )

Default constructor.

Parameters

[in] loc MPVLocation of fields data: POINT, CELL or INTERFACE.

Definition at line 36 of file SelectScalarField.cpp.

◆ SelectScalarField() [2/3]

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

Custom constructor reading xml data

Parameters

[in] rootXML reference to your xml tree section

Definition at line 46 of file SelectScalarField.cpp.

◆ SelectScalarField() [3/3]

mimmo::SelectScalarField::SelectScalarField ( const SelectScalarField & other )

Copy constructor

Definition at line 81 of file SelectScalarField.cpp.

◆ ~SelectScalarField()

mimmo::SelectScalarField::~SelectScalarField ( )

virtual

Default destructor

Definition at line 76 of file SelectScalarField.cpp.

Member Function Documentation

◆ absorbSectionXML()

void mimmo::SelectScalarField::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::SelectField.

Definition at line 280 of file SelectScalarField.cpp.

◆ addField()

void mimmo::SelectScalarField::addField ( dmpvector1D * field )

Add a field to the list of input fields.

Parameters

[in] field scalar field

Definition at line 145 of file SelectScalarField.cpp.

◆ buildPorts()

void mimmo::SelectScalarField::buildPorts ( )

virtual

Build the ports of the class;

Reimplemented from mimmo::SelectField.

Definition at line 104 of file SelectScalarField.cpp.

◆ clear()

void mimmo::SelectScalarField::clear ( )

Clear content of the class

Definition at line 157 of file SelectScalarField.cpp.

◆ flushSectionXML()

void mimmo::SelectScalarField::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::SelectField.

Definition at line 308 of file SelectScalarField.cpp.

◆ getSelectedField()

dmpvector1D * mimmo::SelectScalarField::getSelectedField ( )

Get Selected field.

Returns: Selected field

Definition at line 119 of file SelectScalarField.cpp.

◆ plotOptionalResults()

void mimmo::SelectScalarField::plotOptionalResults ( )

virtual

Plot Selected field on its geometry

Reimplemented from mimmo::BaseManipulation.

Definition at line 167 of file SelectScalarField.cpp.

◆ setFields()

void mimmo::SelectScalarField::setFields ( std::vector< dmpvector1D * > fields )

Set list of input fields.

Parameters

[in] fields scalar fields

Definition at line 128 of file SelectScalarField.cpp.

◆ swap()

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

protectednoexcept

Swap function.

Parameters

[in] x object to be swapped

Definition at line 91 of file SelectScalarField.cpp.

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

src/geohandlers/SelectField.hpp
src/geohandlers/SelectScalarField.cpp

Our website uses cookies

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectScalarField() [1/3]

◆ SelectScalarField() [2/3]

◆ SelectScalarField() [3/3]

◆ ~SelectScalarField()

Member Function Documentation

◆ absorbSectionXML()

◆ addField()

◆ buildPorts()

◆ clear()

◆ flushSectionXML()

◆ getSelectedField()

◆ plotOptionalResults()

◆ setFields()

◆ swap()