typedefs

Custom typedefs available in mimmo. More...

Typedefs
typedef std::unordered_map< BaseManipulation *, int >	mimmo::BaseManipulation::bmumap
typedef std::vector< double >	dvector1D
typedef std::vector< float >	fvector1D
typedef std::vector< int >	ivector1D
typedef std::vector< long >	livector1D
typedef std::vector< uint32_t >	u32vector1D
typedef std::vector< short int >	shivector1D
typedef std::vector< bool >	bvector1D
typedef std::vector< char >	cvector1D
typedef std::vector< std::string >	svector1D
typedef std::array< double, 2 >	darray2E
typedef std::array< double, 3 >	darray3E
typedef std::array< double, 4 >	darray4E
typedef std::array< float, 3 >	farray3E
typedef std::array< int, 3 >	iarray3E
typedef std::array< int, 2 >	iarray2E
typedef std::array< uint32_t, 3 >	uarray3E
typedef std::vector< darray2E >	dvecarr2E
typedef std::vector< darray3E >	dvecarr3E
typedef std::vector< darray4E >	dvecarr4E
typedef std::vector< farray3E >	fvecarr3E
typedef std::vector< iarray3E >	ivecarr3E
typedef std::vector< iarray2E >	ivecarr2E
typedef std::vector< dvector1D >	dvector2D
typedef std::vector< fvector1D >	fvector2D
typedef std::vector< ivector1D >	ivector2D
typedef std::vector< livector1D >	livector2D
typedef std::vector< shivector1D >	shivector2D
typedef std::vector< bvector1D >	bvector2D
typedef std::vector< cvector1D >	cvector2D
typedef std::vector< svector1D >	svector2D
typedef std::vector< bvector2D >	bvector3D
typedef std::vector< bvector3D >	bvector4D
typedef std::vector< cvector2D >	cvector3D
typedef std::vector< cvector3D >	cvector4D
typedef std::vector< ivector2D >	ivector3D
typedef std::vector< ivector3D >	ivector4D
typedef std::vector< dvector2D >	dvector3D
typedef std::vector< dvector3D >	dvector4D
typedef std::vector< svector2D >	svector3D
typedef std::vector< svector3D >	svector4D
typedef std::array< darray2E, 3 >	dmatrix32E
typedef std::array< darray3E, 3 >	dmatrix33E
typedef std::array< darray4E, 4 >	dmatrix44E
typedef std::array< uarray3E, 3 >	umatrix33E
typedef std::array< dvector1D, 3 >	darr3Evec
typedef std::array< darr3Evec, 3 >	dmat33Evec
typedef std::unordered_map< long int, long int >	lilimap
typedef std::string	mimmo::PortID
typedef std::string	mimmo::containerTAG
typedef std::string	mimmo::dataTAG
typedef mimmo::MimmoPiercedVector< bool >	mimmo::bmpvector1D
typedef bitpit::PiercedVector< std::pair< bool, uint8_t >, long >	mimmo::btpvector1D
typedef mimmo::MimmoPiercedVector< double >	mimmo::dmpvector1D
typedef mimmo::MimmoPiercedVector< std::vector< double > >	mimmo::dmpvector2D
typedef mimmo::MimmoPiercedVector< long int >	mimmo::limpvector1D
typedef mimmo::MimmoPiercedVector< std::vector< long int > >	mimmo::limpvector2D
typedef mimmo::MimmoPiercedVector< darray3E >	mimmo::dmpvecarr3E
typedef std::unordered_map< std::string, int >	mimmo::ControlDeformExtSurface::fileListWithType
	mimmo::ControlDeformExtSurface::ControlDeformExtSurface ()
	mimmo::ControlDeformExtSurface::ControlDeformExtSurface (const bitpit::Config::Section &rootXML)
virtual	mimmo::ControlDeformExtSurface::~ControlDeformExtSurface ()
	mimmo::ControlDeformExtSurface::ControlDeformExtSurface (const ControlDeformExtSurface &other)
ControlDeformExtSurface &	mimmo::ControlDeformExtSurface::operator= (ControlDeformExtSurface other)
void	mimmo::ControlDeformExtSurface::buildPorts ()
double	mimmo::ControlDeformExtSurface::getViolation ()
dmpvector1D *	mimmo::ControlDeformExtSurface::getViolationField ()
double	mimmo::ControlDeformExtSurface::getTolerance ()
const fileListWithType &	mimmo::ControlDeformExtSurface::getConstraintFiles () const
void	mimmo::ControlDeformExtSurface::setDefField (dmpvecarr3E *field)
void	mimmo::ControlDeformExtSurface::setGeometry (MimmoSharedPointer< MimmoObject > target)
void	mimmo::ControlDeformExtSurface::setTolerance (double tol)
void	mimmo::ControlDeformExtSurface::addConstraint (MimmoSharedPointer< MimmoObject > constraint)
void	mimmo::ControlDeformExtSurface::setConstraintFiles (fileListWithType list)
void	mimmo::ControlDeformExtSurface::addConstraintFile (std::string file, int format)
void	mimmo::ControlDeformExtSurface::addConstraintFile (std::string file, FileType format)
void	mimmo::ControlDeformExtSurface::removeConstraintFile (std::string)
void	mimmo::ControlDeformExtSurface::removeConstraintFiles ()
void	mimmo::ControlDeformExtSurface::clear ()
void	mimmo::ControlDeformExtSurface::execute ()
virtual void	mimmo::ControlDeformExtSurface::absorbSectionXML (const bitpit::Config::Section &slotXML, std::string name="")
virtual void	mimmo::ControlDeformExtSurface::flushSectionXML (bitpit::Config::Section &slotXML, std::string name="")
void	mimmo::ControlDeformExtSurface::plotOptionalResults ()
void	mimmo::ControlDeformExtSurface::swap (ControlDeformExtSurface &x) noexcept

Detailed Description

Custom typedefs available in mimmo.

Typedef Documentation

bmpvector1D

typedef mimmo::MimmoPiercedVector<bool> mimmo::bmpvector1D

mimmo custom typedef

Definition at line 123 of file MimmoPiercedVector.hpp.

bmumap

typedef std::unordered_map<BaseManipulation*, int> mimmo::BaseManipulation::bmumap

{ Unordered map type used for parent/child storing.

Definition at line 136 of file BaseManipulation.hpp.

btpvector1D

typedef bitpit::PiercedVector<std::pair<bool, uint8_t>, long> mimmo::btpvector1D

mimmo custom typedef

Definition at line 124 of file MimmoPiercedVector.hpp.

bvector1D

typedef std::vector<bool> bvector1D

mimmo custom typedef

Definition at line 45 of file mimmoTypeDef.hpp.

bvector2D

typedef std::vector<bvector1D> bvector2D

mimmo custom typedef

Definition at line 71 of file mimmoTypeDef.hpp.

bvector3D

typedef std::vector< bvector2D > bvector3D

mimmo custom typedef

Definition at line 75 of file mimmoTypeDef.hpp.

bvector4D

typedef std::vector< bvector3D > bvector4D

mimmo custom typedef

Definition at line 76 of file mimmoTypeDef.hpp.

containerTAG

typedef std::string mimmo::containerTAG

containerTAG typedef

Definition at line 39 of file InOut.hpp.

cvector1D

typedef std::vector<char> cvector1D

mimmo custom typedef

Definition at line 46 of file mimmoTypeDef.hpp.

cvector2D

typedef std::vector<cvector1D> cvector2D

mimmo custom typedef

Definition at line 72 of file mimmoTypeDef.hpp.

cvector3D

typedef std::vector< cvector2D > cvector3D

mimmo custom typedef

Definition at line 77 of file mimmoTypeDef.hpp.

cvector4D

typedef std::vector< cvector3D > cvector4D

mimmo custom typedef

Definition at line 78 of file mimmoTypeDef.hpp.

darr3Evec

typedef std::array<dvector1D,3> darr3Evec

mimmo custom typedef

Definition at line 91 of file mimmoTypeDef.hpp.

darray2E

typedef std::array<double,2> darray2E

mimmo custom typedef

Definition at line 49 of file mimmoTypeDef.hpp.

darray3E

typedef std::array<double,3> darray3E

mimmo custom typedef

Definition at line 50 of file mimmoTypeDef.hpp.

darray4E

typedef std::array<double,4> darray4E

mimmo custom typedef

Definition at line 51 of file mimmoTypeDef.hpp.

dataTAG

typedef std::string mimmo::dataTAG

dataTAG typedef

Definition at line 40 of file InOut.hpp.

dmat33Evec

typedef std::array<darr3Evec,3> dmat33Evec

mimmo custom typedef

Definition at line 92 of file mimmoTypeDef.hpp.

dmatrix32E

typedef std::array<darray2E,3> dmatrix32E

mimmo custom typedef

Definition at line 86 of file mimmoTypeDef.hpp.

dmatrix33E

typedef std::array<darray3E,3> dmatrix33E

mimmo custom typedef

Definition at line 87 of file mimmoTypeDef.hpp.

dmatrix44E

typedef std::array<darray4E,4> dmatrix44E

mimmo custom typedef

Definition at line 88 of file mimmoTypeDef.hpp.

dmpvecarr3E

typedef mimmo::MimmoPiercedVector<darray3E> mimmo::dmpvecarr3E

mimmo custom typedef

Definition at line 129 of file MimmoPiercedVector.hpp.

dmpvector1D

typedef mimmo::MimmoPiercedVector<double> mimmo::dmpvector1D

mimmo custom typedef

Definition at line 125 of file MimmoPiercedVector.hpp.

dmpvector2D

typedef mimmo::MimmoPiercedVector<std::vector<double> > mimmo::dmpvector2D

mimmo custom typedef

Definition at line 126 of file MimmoPiercedVector.hpp.

dvecarr2E

typedef std::vector<darray2E> dvecarr2E

mimmo custom typedef

Definition at line 57 of file mimmoTypeDef.hpp.

dvecarr3E

typedef std::vector<darray3E> dvecarr3E

mimmo custom typedef

Definition at line 58 of file mimmoTypeDef.hpp.

dvecarr4E

typedef std::vector<darray4E> dvecarr4E

mimmo custom typedef

Definition at line 59 of file mimmoTypeDef.hpp.

dvector1D

typedef std::vector<double> dvector1D

mimmo custom typedef

Definition at line 39 of file mimmoTypeDef.hpp.

dvector2D

typedef std::vector<dvector1D> dvector2D

mimmo custom typedef

Definition at line 64 of file mimmoTypeDef.hpp.

dvector3D

typedef std::vector< dvector2D > dvector3D

mimmo custom typedef

Definition at line 81 of file mimmoTypeDef.hpp.

dvector4D

typedef std::vector< dvector3D > dvector4D

mimmo custom typedef

Definition at line 82 of file mimmoTypeDef.hpp.

farray3E

typedef std::array<float,3> farray3E

mimmo custom typedef

Definition at line 52 of file mimmoTypeDef.hpp.

fileListWithType

typedef std::unordered_map<std::string, int> mimmo::ControlDeformExtSurface::fileListWithType

custom typedef for a structure hosting a list of filenames with a double and int values attached on it

Definition at line 111 of file ControlDeformExtSurface.hpp.

fvecarr3E

typedef std::vector<farray3E> fvecarr3E

mimmo custom typedef

Definition at line 60 of file mimmoTypeDef.hpp.

fvector1D

typedef std::vector<float> fvector1D

mimmo custom typedef

Definition at line 40 of file mimmoTypeDef.hpp.

fvector2D

typedef std::vector<fvector1D> fvector2D

mimmo custom typedef

Definition at line 65 of file mimmoTypeDef.hpp.

iarray2E

typedef std::array<int,2> iarray2E

mimmo custom typedef

Definition at line 54 of file mimmoTypeDef.hpp.

iarray3E

typedef std::array<int,3> iarray3E

mimmo custom typedef

Examples

core_example_00002.cpp, genericinput_example_00003.cpp, ioofoam_example_00001.cpp, and utils_example_00004.cpp.

Definition at line 53 of file mimmoTypeDef.hpp.

ivecarr2E

typedef std::vector<iarray2E> ivecarr2E

mimmo custom typedef

Definition at line 62 of file mimmoTypeDef.hpp.

ivecarr3E

typedef std::vector<iarray3E> ivecarr3E

mimmo custom typedef

Definition at line 61 of file mimmoTypeDef.hpp.

ivector1D

typedef std::vector<int> ivector1D

mimmo custom typedef

Examples

ioofoam_example_00001.cpp.

Definition at line 41 of file mimmoTypeDef.hpp.

ivector2D

typedef std::vector<ivector1D> ivector2D

mimmo custom typedef

Definition at line 68 of file mimmoTypeDef.hpp.

ivector3D

typedef std::vector< ivector2D > ivector3D

mimmo custom typedef

Definition at line 79 of file mimmoTypeDef.hpp.

ivector4D

typedef std::vector< ivector3D > ivector4D

mimmo custom typedef

Definition at line 80 of file mimmoTypeDef.hpp.

lilimap

typedef std::unordered_map<long int, long int> lilimap

mimmo custom typedef

Definition at line 94 of file mimmoTypeDef.hpp.

limpvector1D

typedef mimmo::MimmoPiercedVector<long int> mimmo::limpvector1D

mimmo custom typedef

Definition at line 127 of file MimmoPiercedVector.hpp.

limpvector2D

typedef mimmo::MimmoPiercedVector<std::vector<long int> > mimmo::limpvector2D

mimmo custom typedef

Definition at line 128 of file MimmoPiercedVector.hpp.

livector1D

typedef std::vector<long> livector1D

mimmo custom typedef

Examples

geohandlers_example_00004.cpp.

Definition at line 42 of file mimmoTypeDef.hpp.

livector2D

typedef std::vector<livector1D> livector2D

mimmo custom typedef

Definition at line 69 of file mimmoTypeDef.hpp.

PortID

typedef std::string mimmo::PortID

port ID typedef

Definition at line 32 of file InOut.hpp.

shivector1D

typedef std::vector<short int> shivector1D

mimmo custom typedef

Definition at line 44 of file mimmoTypeDef.hpp.

shivector2D

typedef std::vector<shivector1D> shivector2D

mimmo custom typedef

Definition at line 70 of file mimmoTypeDef.hpp.

svector1D

typedef std::vector<std::string> svector1D

mimmo custom typedef

Definition at line 47 of file mimmoTypeDef.hpp.

svector2D

typedef std::vector<svector1D> svector2D

mimmo custom typedef

Definition at line 73 of file mimmoTypeDef.hpp.

svector3D

typedef std::vector< svector2D > svector3D

mimmo custom typedef

Definition at line 83 of file mimmoTypeDef.hpp.

svector4D

typedef std::vector< svector3D > svector4D

mimmo custom typedef

Definition at line 84 of file mimmoTypeDef.hpp.

u32vector1D

typedef std::vector<uint32_t> u32vector1D

mimmo custom typedef

Definition at line 43 of file mimmoTypeDef.hpp.

uarray3E

typedef std::array<uint32_t,3> uarray3E

mimmo custom typedef

Definition at line 55 of file mimmoTypeDef.hpp.

umatrix33E

typedef std::array<uarray3E,3> umatrix33E

mimmo custom typedef

Definition at line 89 of file mimmoTypeDef.hpp.

Function Documentation

ControlDeformExtSurface() [1/3]

mimmo::ControlDeformExtSurface::ControlDeformExtSurface

(

)

Default constructor of ControlDeformExtSurface

Definition at line 34 of file ControlDeformExtSurface.cpp.

ControlDeformExtSurface() [2/3]

mimmo::ControlDeformExtSurface::ControlDeformExtSurface

(

const bitpit::Config::Section &

rootXML

)

Custom constructor reading xml data

Parameters

[in]

rootXML

reference to your xml tree section

Definition at line 48 of file ControlDeformExtSurface.cpp.

ControlDeformExtSurface() [3/3]

mimmo::ControlDeformExtSurface::ControlDeformExtSurface

(

const ControlDeformExtSurface &

other

)

Copy constructor of ControlDeformExtSurface. Deformation field referred to geometry and result violation field are not copied.

Definition at line 73 of file ControlDeformExtSurface.cpp.

~ControlDeformExtSurface()

mimmo::ControlDeformExtSurface::~ControlDeformExtSurface ( )

virtual

Default destructor of ControlDeformExtSurface

Definition at line 68 of file ControlDeformExtSurface.cpp.

absorbSectionXML()

void mimmo::ControlDeformExtSurface::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 423 of file ControlDeformExtSurface.cpp.

addConstraint()

void mimmo::ControlDeformExtSurface::addConstraint

(

MimmoSharedPointer< MimmoObject >

constraint

)

Add a surface geometry as constraint for violation control. For MPI version, this is the only method to provide partitioned external constraint geometries

Parameters

[in]

constraint

pointer to constraint geometry

Examples

utils_example_00002.cpp.

Definition at line 220 of file ControlDeformExtSurface.cpp.

addConstraintFile() [1/2]

void mimmo::ControlDeformExtSurface::addConstraintFile	(	std::string	file,
		FileType	format
	)

As setConstraintFiles, but adding a new constraint geometry file once at the time.

Parameters

[in]	file	of external geometry to be read
[in]	format	type of file as Filetype enum. only nas, stl, stvtu and sqvtu are supported.

Definition at line 265 of file ControlDeformExtSurface.cpp.

addConstraintFile() [2/2]

void mimmo::ControlDeformExtSurface::addConstraintFile	(	std::string	file,
		int	format
	)

As setConstraintFiles, but adding a new constraint geometry file once at the time.

Parameters

[in]	file	of external geometry to be read
[in]	format	type of file as integer (see Filetype enum). only nas, stl, surfvtu and nas are supported.

Examples

utils_example_00002.cpp.

Definition at line 254 of file ControlDeformExtSurface.cpp.

buildPorts()

void mimmo::ControlDeformExtSurface::buildPorts ( )

virtual

It builds the input/output ports of the object

Implements mimmo::BaseManipulation.

Definition at line 106 of file ControlDeformExtSurface.cpp.

clear()

void mimmo::ControlDeformExtSurface::clear

(

)

Reset class to default parameters.

Definition at line 290 of file ControlDeformExtSurface.cpp.

execute()

void mimmo::ControlDeformExtSurface::execute ( )

virtual

Execution command. Calculate violation value and store it in the class member m_violationField

Implements mimmo::BaseManipulation.

Definition at line 303 of file ControlDeformExtSurface.cpp.

flushSectionXML()

void mimmo::ControlDeformExtSurface::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 478 of file ControlDeformExtSurface.cpp.

getConstraintFiles()

const ControlDeformExtSurface::fileListWithType & mimmo::ControlDeformExtSurface::getConstraintFiles

(

)

const

Return the actual list of external geometry files selected as constraint to check your deformation. Only constraints specified by files are returned.

Returns

list of external geometries files with their type

Definition at line 170 of file ControlDeformExtSurface.cpp.

getTolerance()

double mimmo::ControlDeformExtSurface::getTolerance

(

)

Get proximity tolerance for constraints fixed into the class. Tolerance acts as an offset treshold, so that a deformed body can be considered as violating constraints when it's dangerously close, even if it's not really touching/penetrating them.

Returns

fixed proximity tolerance

Definition at line 160 of file ControlDeformExtSurface.cpp.

getViolation()

double mimmo::ControlDeformExtSurface::getViolation

(

)

Return the value of violation of deformed geometry, after class execution. If value is positive or at least zero, constraint violation occurs, penetrating or touching at least in one point the constraint sourface. Otherwise, returning negative values means that no violation occurs.

Returns

violation value

Definition at line 126 of file ControlDeformExtSurface.cpp.

getViolationField()

dmpvector1D * mimmo::ControlDeformExtSurface::getViolationField

(

)

Return the violation field relative to deformed target geometry, onto the geometry itself. The info is available after class execution. If value is positive or at least zero, constraint violation occurs, penetrating or touching at least in one point of the constraint sourface. Otherwise, returning negative values means that no violation occurs.

Returns

violation field values

Definition at line 147 of file ControlDeformExtSurface.cpp.

operator=()

ControlDeformExtSurface & mimmo::ControlDeformExtSurface::operator=

(

ControlDeformExtSurface

other

)

Assignment operator of ControlDeformExtSurface. Deformation field referred to geometry and result violation field are not copied.

Definition at line 84 of file ControlDeformExtSurface.cpp.

plotOptionalResults()

void mimmo::ControlDeformExtSurface::plotOptionalResults ( )

protectedvirtual

Plot optional results in execution, that is the violation distance field on current deformed geometry. Reimeplemented from BaseManipulation::plotOptionalResults;

Reimplemented from mimmo::BaseManipulation.

Definition at line 652 of file ControlDeformExtSurface.cpp.

removeConstraintFile()

void mimmo::ControlDeformExtSurface::removeConstraintFile

(

std::string

file

)

Remove an existent file from the list of external geometry files. If not in the list, do nothing

Parameters

[in]

file

to be removed from the list

Definition at line 274 of file ControlDeformExtSurface.cpp.

removeConstraintFiles()

void mimmo::ControlDeformExtSurface::removeConstraintFiles

(

)

Empty your list of external constraint geometry files

Definition at line 282 of file ControlDeformExtSurface.cpp.

setConstraintFiles()

void mimmo::ControlDeformExtSurface::setConstraintFiles

(

ControlDeformExtSurface::fileListWithType

files

)

Set a list of external geometry files to check your deformation violation. The int format of the file (see FileType enum) must be present as second argument. This is a method to pass constraint geometries to the class, alternative to addConstraint. In case of MPI version, please be aware that since these geometries are read from file, they will be retained on the rank 0 processor only and not properly distributed among ranks. For a full control of distributed geometries, partition them externally and add them to the class using addConstraint method.

Parameters

[in]

files

list external geometries to be read

Definition at line 242 of file ControlDeformExtSurface.cpp.

setDefField()

void mimmo::ControlDeformExtSurface::setDefField

(

dmpvecarr3E *

field

)

Set the deformative field associated to each point of the target geometry. Field resize occurs in execution, if point dimension between field and geoemetry does not match.

Parameters

[in]

field

of deformation

Examples

utils_example_00002.cpp.

Definition at line 180 of file ControlDeformExtSurface.cpp.

setGeometry()

void mimmo::ControlDeformExtSurface::setGeometry

(

MimmoSharedPointer< MimmoObject >

target

)

Set link to target geometry for your selection.

Parameters

[in]

target

pointer to target geometry

Examples

utils_example_00002.cpp.

Definition at line 191 of file ControlDeformExtSurface.cpp.

setTolerance()

void mimmo::ControlDeformExtSurface::setTolerance

(

double

tol

)

Set proximity tolerance for constraints (double >= 0). Tolerance acts as an offset treshold, so that a deformed body can be considered as violating constraints when it's dangerously close, even if it's not really touching/penetrating them.

Parameters

[in]

tol

proximity tolerance

Examples

utils_example_00002.cpp.

Definition at line 209 of file ControlDeformExtSurface.cpp.

swap()

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

protectednoexcept

Swap function.

Parameters

[in]

x

object to be swapped

Definition at line 93 of file ControlDeformExtSurface.cpp.