core

Executable Blocks basic features and data structures. More...

Namespaces
	mimmo::mimmoCGUtils
	Additional Utilities for Elementary Computational Geometry handling in mimmo.
	mimmo::pin
	Utilities to create port connections between executable blocks.
	mimmo::skdTreeUtils
	Utilities employing SkdTree.

Classes
class	mimmo::BaseManipulation
	BaseManipulation is the base class of any manipulation object of the library. More...
class	mimmo::BasicShape
	Abstract Interface class for Elementary Shape Representation. More...
class	mimmo::Chain
	Chain is the class used to manage the chain execution of multiple executable blocks (manipulation object). More...
class	mimmo::Cube
	Elementary Shape Representation of a Cube. More...
class	mimmo::Cylinder
	Elementary Shape Representation of a Cylinder or portion of it. More...
class	mimmo::DataType
	Class DataType defines the container and the type of data communicated by ports. More...
class	mimmo::FileDataInfo
	FileDataInfo is a struct to stock data relative to names of external files. More...
class	mimmo::IOConnections_MIMMO
	IOConnections_MIMMO is a class to read/write mimmo pin connections from XML IO/parser defined in bitpit::Config. More...
class	mimmo::Lattice
	Structured 3D Cartesian Mesh. More...
class	mimmo::MimmoObject
	MimmoObject is the basic geometry container for mimmo library. More...
class	mimmo::MimmoPiercedVector< mpv_t >
	MimmoPiercedVector is the basic data container for mimmo library. More...
class	mimmo::MimmoPointCloud
	Custom derivation of bitpit::SurfUnstructured class, for Point Cloud handling only. More...
class	mimmo::MimmoSharedPointer
	MimmoSharedPointer is a custom implementation of shared pointer. More...
class	mimmo::MimmoSurfUnstructured
	Custom derivation of bitpit::SurfUnstructured class. More...
class	mimmo::MimmoVolUnstructured
	Custom derivation of bitpit::VolUnstructured class. More...
class	mimmo::Module
	Module is an executable block class capable of computing the magnitude field of a vector field. More...
class	mimmo::PortIn
	PortIn is the abstract PIN base class dedicated to carry data to a target class from other ones (input). More...
class	mimmo::PortInT< T, O >
	PortInT is the PIN class to get input data arriving to an object from other objects. More...
class	mimmo::PortOut
	PortOut is the abstract PIN base class dedicated to exchange data from a target class to other ones (output). More...
class	mimmo::PortOutT< T, O >
	PortOutT is the PIN class to exchange output data from an object to others. More...
class	mimmo::Primitive
	Primitive object generation. More...
class	mimmo::Sphere
	Elementary Shape Representation of a Sphere or portion of it. More...
class	mimmo::UStructMesh
	Class for 3D uniform structured mesh. More...
class	mimmo::VTUAbsorbStreamer
	Abstract class for custom reader/absorber of *.vtu mesh external files. More...
class	mimmo::VTUFlushStreamerASCII
	Abstract class for custom ASCII writer/flusher of *.vtu mesh external files. More...
class	mimmo::VTUGridReader
	Custom reader of unstructured grids from external files *.vtu. More...
class	mimmo::VTUGridStreamer
	Custom mesh/data absorber for unstructured grids given by external files *.vtu. More...
class	mimmo::VTUGridWriterASCII
	Custom writer of ASCII unstructured grids to external files *.vtu. More...
class	mimmo::Wedge
	Elementary Shape Representation of a Prism with triangular basis. More...

Enumerations
enum	mimmo::CoordType { mimmo::CoordType::UNCLAMPED =0, mimmo::CoordType::CLAMPED =1, mimmo::CoordType::PERIODIC =2, mimmo::CoordType::SYMMETRIC =3 }
	Specify type of conditions to distribute NURBS nodes in a given coordinate of the shape. More...
enum	mimmo::MPVLocation : long { mimmo::MPVLocation::UNDEFINED = 0, mimmo::MPVLocation::POINT = 1, mimmo::MPVLocation::CELL = 2, mimmo::MPVLocation::INTERFACE = 3 }
	Define data location for the MimmoPiercedVector field. More...
enum	mimmo::ShapeType { mimmo::ShapeType::CUBE =0, mimmo::ShapeType::CYLINDER =1, mimmo::ShapeType::SPHERE =3, mimmo::ShapeType::WEDGE =4 }
	Identifies the type of elemental shape supported by BasicShape class. More...
enum	mimmo::SyncStatus : long { mimmo::SyncStatus::NOTSUPPORTED = -1, mimmo::SyncStatus::NONE = 0, mimmo::SyncStatus::UNSYNC = 1, mimmo::SyncStatus::SYNC = 2 }
	Define status of mimmo object structures like adjacencies, interfaces, etc. More...
void	mimmo::setLogger (std::string log)
void	mimmo::setLoggerDirectory (std::string dir)
void	mimmo::warningXML (bitpit::Logger *log, std::string name)
void	mimmo::setExpertMode (bool flag)

Detailed Description

Executable Blocks basic features and data structures.

Enumeration Type Documentation

CoordType

enum mimmo::CoordType

strong

Specify type of conditions to distribute NURBS nodes in a given coordinate of the shape.

Enumerator
UNCLAMPED	free clamping conditions
CLAMPED	force nurbs to pass on the extremal point of the interval (clamping)
PERIODIC	provide periodic condition on the interval extrema
SYMMETRIC	provide simmetry condition on the interval extrema

Definition at line 49 of file BasicShapes.hpp.

MPVLocation

enum mimmo::MPVLocation : long

strong

Define data location for the MimmoPiercedVector field.

Enumerator
UNDEFINED	unknown location data
POINT	data on geometry vertices
CELL	data on geometry cells
INTERFACE	data on geometry interfaces

Definition at line 39 of file MimmoPiercedVector.hpp.

ShapeType

enum mimmo::ShapeType

strong

Identifies the type of elemental shape supported by BasicShape class.

Enumerator
CUBE	Cubic or generic voxel-shaped objects.
CYLINDER	Cylindrical objects.
SPHERE	Spherical objects.
WEDGE	Base triangular prism objects

Definition at line 38 of file BasicShapes.hpp.

SyncStatus

enum mimmo::SyncStatus : long

strong

Define status of mimmo object structures like adjacencies, interfaces, etc.

Enumerator
NOTSUPPORTED	structure not supported
NONE	structure not built
UNSYNC	structure unsynchronized with geometry status
SYNC	structure synchronized with geometry status

Definition at line 123 of file MimmoObject.hpp.

Function Documentation

setExpertMode()

void mimmo::setExpertMode

(

bool

flag

)

If true activate the expert mode for mimmo, i.e. to bypass cross-check of unlinked mandatory ports in workflow-chain mode.

Parameters

[in]

flag

boolean true activate, false deactivate

Examples

genericinput_example_00005.cpp, geohandlers_example_00004.cpp, and utils_example_00003.cpp.

Definition at line 219 of file MimmoNamespace.cpp.

setLogger()

void mimmo::setLogger

(

std::string

log

)

Change the name of the mimmo custom logger.

Parameters

[in]

log

name of the logger file.

Examples

utils_example_00002.cpp, utils_example_00003.cpp, and utils_example_00005.cpp.

Definition at line 185 of file MimmoNamespace.cpp.

setLoggerDirectory()

void mimmo::setLoggerDirectory

(

std::string

dir

)

Change the directory of the mimmo custom logger.

Parameters

[in]

dir

directory of the logger file.

Definition at line 198 of file MimmoNamespace.cpp.

warningXML()

void mimmo::warningXML	(	bitpit::Logger *	log,
		std::string	name
	)

Return basic warning for no data found in xml dictionary.

Parameters

[in]	log	pointer to logger file.
[in]	name	name of the mimmo block.

Definition at line 211 of file MimmoNamespace.cpp.