SelectVectorField is specialized derived class of SelectField to Select a vector field. More...

#include <SelectField.hpp>

Inheritance diagram for mimmo::SelectVectorField:
Collaboration diagram for mimmo::SelectVectorField:

Public Member Functions

 SelectVectorField (const bitpit::Config::Section &rootXMl)
 
 SelectVectorField (const SelectVectorField &other)
 
 SelectVectorField (MPVLocation loc=MPVLocation::POINT)
 
virtual ~SelectVectorField ()
 
virtual void absorbSectionXML (const bitpit::Config::Section &slotXML, std::string name="")
 
void addField (dmpvecarr3E *field)
 
void buildPorts ()
 
void clear ()
 
virtual void flushSectionXML (bitpit::Config::Section &slotXML, std::string name="")
 
dmpvecarr3EgetSelectedField ()
 
void plotOptionalResults ()
 
void setFields (std::vector< dmpvecarr3E * > 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 ()
 
BaseManipulationgetChild (int i=0)
 
ConnectionType getConnectionType ()
 
MimmoSharedPointer< MimmoObjectgetGeometry ()
 
MimmoSharedPointer< MimmoObject > & getGeometryReference ()
 
int getId ()
 
bitpit::Logger & getLog ()
 
std::string getName ()
 
int getNChild ()
 
int getNParent ()
 
int getNPortsIn ()
 
int getNPortsOut ()
 
BaseManipulationgetParent (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 ()
 
BaseManipulationoperator= (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 (SelectVectorField &) 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< MimmoObjectm_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

SelectVectorField is specialized derived class of SelectField to Select a vector field.

Ports available in SelectVectorField Class :


Port Input
PortType variable/function DataType
M_VECVECTORFIELDS setFields (MC_VECTOR, MD_MPVECARR3FLOAT_)
M_VECTORFIELD addField (MC_SCALAR, MD_MPVECARR3FLOAT_)
Port Output
PortType variable/function DataType
M_VECTORFIELD getSelectedField (MC_SCALAR, MD_MPVECARR3FLOAT_)

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.SelectVectorField
  • 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 282 of file SelectField.hpp.

Constructor & Destructor Documentation

◆ SelectVectorField() [1/3]

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

Default constructor.

Parameters
[in]locMPVLocation of fields data: POINT, CELL or INTERFACE.

Definition at line 36 of file SelectVectorField.cpp.

◆ SelectVectorField() [2/3]

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

Custom constructor reading xml data

Parameters
[in]rootXMLreference to your xml tree section

Definition at line 46 of file SelectVectorField.cpp.

◆ SelectVectorField() [3/3]

mimmo::SelectVectorField::SelectVectorField ( const SelectVectorField other)

Copy constructor

Definition at line 80 of file SelectVectorField.cpp.

◆ ~SelectVectorField()

mimmo::SelectVectorField::~SelectVectorField ( )
virtual

Default destructor

Definition at line 75 of file SelectVectorField.cpp.

Member Function Documentation

◆ absorbSectionXML()

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

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

Parameters
[in]slotXMLbitpit::Config::Section of XML file
[in]namename associated to the slot

Reimplemented from mimmo::SelectField.

Definition at line 278 of file SelectVectorField.cpp.

◆ addField()

void mimmo::SelectVectorField::addField ( dmpvecarr3E field)

Add a field to the list of input fields.

Parameters
[in]fieldscalar field

Definition at line 144 of file SelectVectorField.cpp.

◆ buildPorts()

void mimmo::SelectVectorField::buildPorts ( )
virtual

Build the ports of the class;

Reimplemented from mimmo::SelectField.

Definition at line 103 of file SelectVectorField.cpp.

◆ clear()

void mimmo::SelectVectorField::clear ( )

Clear content of the class

Definition at line 155 of file SelectVectorField.cpp.

◆ flushSectionXML()

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

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

Parameters
[in]slotXMLbitpit::Config::Section of XML file
[in]namename associated to the slot

Reimplemented from mimmo::SelectField.

Definition at line 306 of file SelectVectorField.cpp.

◆ getSelectedField()

dmpvecarr3E * mimmo::SelectVectorField::getSelectedField ( )

Get Selected field.

Returns
Selected field

Definition at line 118 of file SelectVectorField.cpp.

◆ plotOptionalResults()

void mimmo::SelectVectorField::plotOptionalResults ( )
virtual

Plot Selected field on its geometry.

Reimplemented from mimmo::BaseManipulation.

Definition at line 165 of file SelectVectorField.cpp.

◆ setFields()

void mimmo::SelectVectorField::setFields ( std::vector< dmpvecarr3E * >  fields)

Set list of input fields.

Parameters
[in]fieldsscalar fields

Definition at line 127 of file SelectVectorField.cpp.

◆ swap()

void mimmo::SelectVectorField::swap ( SelectVectorField x)
protectednoexcept

Swap function.

Parameters
[in]xobject to be swapped

Definition at line 90 of file SelectVectorField.cpp.


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