ExtractVectorField is specialized derived class of ExtractField to extract a vector field of array<double,3>. More...
#include <ExtractFields.hpp>
Protected Member Functions | |
void | swap (ExtractVectorField &x) noexcept |
Protected Member Functions inherited from mimmo::ExtractField | |
void | swap (ExtractField &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) |
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::ExtractField | |
ExtractMode | 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
ExtractVectorField is specialized derived class of ExtractField to extract a vector field of array<double,3>.
Ports available in ExtractVectorField Class :
Port Input | ||
---|---|---|
PortType | variable/function | DataType |
M_VECTORFIELD | setField | (MC_SCALAR, MD_MPVECARR3FLOAT_) |
Port Output | ||
---|---|---|
PortType | variable/function | DataType |
M_VECTORFIELD | getExtractedField | (MC_SCALAR, MD_MPVECARR3FLOAT_) |
Inherited from ExtractField
Port Input | ||
---|---|---|
PortType | variable/function | DataType |
M_GEOM | setGeometry | (MC_SCALAR, MD_MIMMO_) |
Port Output | ||
---|---|---|
PortType | variable/function | DataType |
Parameters: Inherited from BaseManipulation:
- ClassName: name of the class as
mimmo.ExtractVectorField
- 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 ExtractField:
- ExtractMode: activate extraction mode by ID(1), PID(2) or MAPPING(3);
- Tolerance: tolerance for extraction by patch, valid only in Mapping mode.
- Examples
- geohandlers_example_00003.cpp, and iocgns_example_00001.cpp.
Definition at line 263 of file ExtractFields.hpp.
Constructor & Destructor Documentation
◆ ExtractVectorField() [1/3]
mimmo::ExtractVectorField::ExtractVectorField | ( | ) |
Default constructor.
Definition at line 33 of file ExtractVectorField.cpp.
◆ ExtractVectorField() [2/3]
mimmo::ExtractVectorField::ExtractVectorField | ( | const bitpit::Config::Section & | rootXML | ) |
Custom constructor reading xml data
- Parameters
-
[in] rootXML reference to your xml tree section
Definition at line 41 of file ExtractVectorField.cpp.
◆ ~ExtractVectorField()
|
virtual |
Default destructor
Definition at line 59 of file ExtractVectorField.cpp.
◆ ExtractVectorField() [3/3]
mimmo::ExtractVectorField::ExtractVectorField | ( | const ExtractVectorField & | other | ) |
Copy Constructor.
- Parameters
-
[in] other class of type ExtractField
Definition at line 65 of file ExtractVectorField.cpp.
Member Function Documentation
◆ buildPorts()
|
virtual |
Build the ports of the class;
Reimplemented from mimmo::ExtractField.
Definition at line 97 of file ExtractVectorField.cpp.
◆ clear()
void mimmo::ExtractVectorField::clear | ( | ) |
Clear content of the class
Definition at line 140 of file ExtractVectorField.cpp.
◆ extract()
|
virtual |
Extract field from your original field by using the provided target geometry
- Returns
- true if extract without errors
Implements mimmo::ExtractField.
Definition at line 163 of file ExtractVectorField.cpp.
◆ getExtractedField()
dmpvecarr3E * mimmo::ExtractVectorField::getExtractedField | ( | ) |
◆ getOriginalField()
dmpvecarr3E mimmo::ExtractVectorField::getOriginalField | ( | ) |
Get linked field where result need to be extracted from.
- Returns
- original field
Definition at line 122 of file ExtractVectorField.cpp.
◆ operator=()
ExtractVectorField & mimmo::ExtractVectorField::operator= | ( | const ExtractVectorField & | other | ) |
Assignement operator of ExtractField.
- Parameters
-
[in] other class of type ExtractField
Definition at line 74 of file ExtractVectorField.cpp.
◆ plotOptionalResults()
|
virtual |
Plot extracted field over the target geometry
Reimplemented from mimmo::BaseManipulation.
Definition at line 150 of file ExtractVectorField.cpp.
◆ setField()
void mimmo::ExtractVectorField::setField | ( | dmpvecarr3E * | field | ) |
Set input field for extraction.
- Parameters
-
[in] field input field related to whole geometry
Definition at line 131 of file ExtractVectorField.cpp.
◆ swap()
|
protectednoexcept |
Swap function of ExtractVectorField
- Parameters
-
[in] x object to be swapped.
Definition at line 85 of file ExtractVectorField.cpp.
The documentation for this class was generated from the following files:
- src/geohandlers/ExtractFields.hpp
- src/geohandlers/ExtractVectorField.cpp