ExtractScalarField is specialized derived class of ExtractField to extract a scalar field of doubles. More...

#include <ExtractFields.hpp>

Inheritance diagram for mimmo::ExtractScalarField:

Collaboration diagram for mimmo::ExtractScalarField:

[legend]

Public Member Functions
	ExtractScalarField ()

	ExtractScalarField (const bitpit::Config::Section &rootXMl)

	ExtractScalarField (const ExtractScalarField &other)

virtual	~ExtractScalarField ()

void	buildPorts ()

void	clear ()

bool	extract ()

dmpvector1D *	getExtractedField ()

dmpvector1D	getOriginalField ()

ExtractScalarField &	operator= (const ExtractScalarField &other)

void	plotOptionalResults ()

void	setField (dmpvector1D *field)

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

	ExtractField (const ExtractField &other)

virtual	~ExtractField ()

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

void	clear ()

void	execute ()

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

ExtractMode	getMode ()

double	getTolerance ()

ExtractField &	operator= (const ExtractField &other)

void	setGeometry (MimmoSharedPointer< MimmoObject > geometry)

void	setMode (ExtractMode mode)

void	setMode (int 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 (ExtractScalarField &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

ExtractScalarField is specialized derived class of ExtractField to extract a scalar field of doubles.

Ports available in ExtractScalarField Class :

Port Input
PortType	variable/function	DataType
M_SCALARFIELD	setField	(MC_SCALAR, MD_MPVECFLOAT_)

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

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.ExtractScalarField;
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, meaningful only in Mapping mode.

Definition at line 180 of file ExtractFields.hpp.

Constructor & Destructor Documentation

◆ ExtractScalarField() [1/3]

mimmo::ExtractScalarField::ExtractScalarField ( )

Default constructor.

Definition at line 33 of file ExtractScalarField.cpp.

◆ ExtractScalarField() [2/3]

mimmo::ExtractScalarField::ExtractScalarField ( 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 ExtractScalarField.cpp.

◆ ~ExtractScalarField()

mimmo::ExtractScalarField::~ExtractScalarField ( )

virtual

Default destructor

Definition at line 59 of file ExtractScalarField.cpp.

◆ ExtractScalarField() [3/3]

mimmo::ExtractScalarField::ExtractScalarField ( const ExtractScalarField & other )

Copy Constructor.

Parameters

[in] other class of type ExtractField

Definition at line 66 of file ExtractScalarField.cpp.

Member Function Documentation

◆ buildPorts()

void mimmo::ExtractScalarField::buildPorts ( )

virtual

Build the ports of the class;

Reimplemented from mimmo::ExtractField.

Definition at line 98 of file ExtractScalarField.cpp.

◆ clear()

void mimmo::ExtractScalarField::clear ( )

Clear content of the class

Definition at line 141 of file ExtractScalarField.cpp.

◆ extract()

bool mimmo::ExtractScalarField::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 ExtractScalarField.cpp.

◆ getExtractedField()

dmpvector1D * mimmo::ExtractScalarField::getExtractedField ( )

Get extracted field.

Returns: extracted field

Definition at line 114 of file ExtractScalarField.cpp.

◆ getOriginalField()

dmpvector1D mimmo::ExtractScalarField::getOriginalField ( )

Get linked field where result need to be extracted from.

Returns: original field

Definition at line 123 of file ExtractScalarField.cpp.

◆ operator=()

ExtractScalarField & mimmo::ExtractScalarField::operator= ( const ExtractScalarField & other )

Assignement operator of ExtractField.

Parameters

[in] other class of type ExtractField

Definition at line 75 of file ExtractScalarField.cpp.

◆ plotOptionalResults()

void mimmo::ExtractScalarField::plotOptionalResults ( )

virtual

Plot extracted field over the target geometry

Reimplemented from mimmo::BaseManipulation.

Definition at line 151 of file ExtractScalarField.cpp.

◆ setField()

void mimmo::ExtractScalarField::setField ( dmpvector1D * field )

Set input field for extraction.

Parameters

[in] field input field related to whole geometry

Definition at line 132 of file ExtractScalarField.cpp.

◆ swap()

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

protectednoexcept

Swap function of ExtractScalarField

Parameters

[in] x object to be swapped.

Definition at line 86 of file ExtractScalarField.cpp.

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

src/geohandlers/ExtractFields.hpp
src/geohandlers/ExtractScalarField.cpp

Our website uses cookies

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExtractScalarField() [1/3]

◆ ExtractScalarField() [2/3]

◆ ~ExtractScalarField()

◆ ExtractScalarField() [3/3]

Member Function Documentation

◆ buildPorts()

◆ clear()

◆ extract()

◆ getExtractedField()

◆ getOriginalField()

◆ operator=()

◆ plotOptionalResults()

◆ setField()

◆ swap()