Output Namespace Reference

Operations to write the results and the mesh for its visualization. More...

Enumerations
enum	CellType { POINTS , CELLS }

Functions
void	initFieldsKeyWords ()
	Initialize the keywords of the fields.
void	writeGrid (Mesh *mesh, CellType cell_type_representation=CellType::CELLS, double time=0.0)
	Write the grid mesh into a vtu file.
void	writeParticles (vector< Particle * > *particles, double time=0.0)
	Write the particles of the model into a vtu file.
void	writeBody (Body *body, double time=0.0)
	Write the particles in a body.
void	writeResultsSeries ()
	Write the time series of the results.
void	writeBodies (vector< Body * > *bodies, double time=0.0)
	Write the particles forming bodies.
void	configureResultFiels (vector< string > fields)
	Configures the fields to be written.
void	configureGridResultFiels (vector< string > fields)
	Configures the grid fields to be written.
bool	isFieldRequired (string field)
	Verify is the grid field must be written.
bool	isGridFieldRequired (string field)
	Verify is the field must be written.
void	writeResultInStep (int resultSteps, vector< Particle * > *particles, double iTime)
	Write results if the step is the step result.
void	writeGridInStep (int resultSteps, Mesh *mesh, double iTime)
	Write grid results if the step is the step result.
void	writeInitialState (vector< Body * > *bodies, double iTime, Mesh *mesh)
	Write the initial state of the simulation.
void	welcomeScreen ()
	Print initial program screen.
void	farewellScreen ()
	Print final program screen.
void	printElapsedTime ()
	Print elapsed time.

Detailed Description

Operations to write the results and the mesh for its visualization.

The results of a numerical simulation are the variables stored in particles in time. These files are written in two folders inside the working directory: particles and grid. In particles folder temporal results are written in vtu files and additional file particleTimeSerie.pvd is created at the end of the simulation containing information of vtu files and time.

Enumeration Type Documentation

CellType

enum Output::CellType

Describes the way that the cells are written in the mesh file

Enumerator
POINTS
CELLS

Function Documentation

configureGridResultFiels()

void Output::configureGridResultFiels

(

vector< string >

fields

)

Configures the grid fields to be written.

Parameters

[in]

fields

List of fields

configureResultFiels()

void Output::configureResultFiels

(

vector< string >

fields

)

Configures the fields to be written.

Parameters

[in]

fields

List of fields

farewellScreen()

void Output::farewellScreen

(

)

Print final program screen.

initFieldsKeyWords()

void Output::initFieldsKeyWords

(

)

Initialize the keywords of the fields.

isFieldRequired()

bool Output::isFieldRequired

(

string

field

)

Verify is the grid field must be written.

Parameters

[in]

field

Grid field to verify

Returns

True if the grid field must be written

isGridFieldRequired()

bool Output::isGridFieldRequired

(

string

field

)

Verify is the field must be written.

Parameters

[in]

field

Field to verify

Returns

True if the field must be written

printElapsedTime()

void Output::printElapsedTime

(

)

Print elapsed time.

welcomeScreen()

void Output::welcomeScreen

(

)

Print initial program screen.

writeBodies()

void Output::writeBodies	(	vector< Body * > *	bodies,
		double	time = 0.0
	)

Write the particles forming bodies.

Parameters

[in]	bodies	Body list
[in]	time	Time

writeBody()

void Output::writeBody	(	Body *	body,
		double	time = 0.0
	)

Write the particles in a body.

Parameters

[in]	body	Body reference
[in]	time	Time

writeGrid()

void Output::writeGrid	(	Mesh *	mesh,
		CellType	cell_type_representation = CellType::CELLS,
		double	time = 0.0
	)

Write the grid mesh into a vtu file.

Parameters

[in]	mesh	Mesh reference
[in]	cell_type_representation	Cell type representation Output::CellType
[in]	time	Time

writeGridInStep()

void Output::writeGridInStep	(	int	resultSteps,
		Mesh *	mesh,
		double	iTime
	)

Write grid results if the step is the step result.

writeInitialState()

void Output::writeInitialState	(	vector< Body * > *	bodies,
		double	iTime,
		Mesh *	mesh
	)

Write the initial state of the simulation.

writeParticles()

void Output::writeParticles	(	vector< Particle * > *	particles,
		double	time = 0.0
	)

Write the particles of the model into a vtu file.

Parameters

[in]	particles	List containing pointers to particles
[in]	time	Time

writeResultInStep()

void Output::writeResultInStep	(	int	resultSteps,
		vector< Particle * > *	particles,
		double	iTime
	)

Write results if the step is the step result.

Parameters

[in]	resultSteps	Result steps
[in]	particles	List of particles
[in]	iTime	Current time

writeResultsSeries()

void Output::writeResultsSeries

(

)

Write the time series of the results.