MPM-Geomechanics/Output_8h_source.html

// SPDX-License-Identifier: MIT

// Copyright (c) 2021-2025 MPM-Geomechanics Development Team


#ifndef OUTPUT_H_

#define OUTPUT_H_


#include "Mesh/Mesh.h"

#include "Particle/Particle.h"

#include "Body/Body.h"

#include "TerrainContact.h"


namespace Output {


    enum CellType{ POINTS, CELLS };


    void initFieldsKeyWords();


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


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


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


    void writeResultsSeries();


    void writeSTLContact(TerrainContact* tc, double time);


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


    void configureResultFields(vector<string> fields);


    void configureGridResultFields(vector<string> fields);


    void configureSTLContactFields(vector<string> fields);


    bool isFieldRequired(string field);


    bool isGridFieldRequired(string field);


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


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


    void writeSTLContactInStep(int resultSteps, TerrainContact* tc, double iTime);


    void writeInitialState(vector<Body*>* bodies, double iTime, Mesh* mesh, TerrainContact* tc);


    void welcomeScreen();


    void farewellScreen();


    void printElapsedTime();

}


#endif /* OUTPUT_H_ */

Body.h

Mesh.h

Particle.h

TerrainContact.h

Body
Represents a body in the space forming by a group of materials points and identified by a number.
Definition Body.h:15

Mesh
Class representing a rectangular grid mesh.
Definition Mesh.h:26

TerrainContact
Class to compute terrain contact.
Definition TerrainContact.h:11

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

Output::writeBody
void writeBody(Body *body, double time=0.0)
Write the particles in a body.

Output::initFieldsKeyWords
void initFieldsKeyWords()
Initialize the keywords of the fields.

Output::writeSTLContact
void writeSTLContact(TerrainContact *tc, double time)
Write the STL contact results.

Output::CellType
CellType
Definition Output.h:21

Output::CELLS
@ CELLS
Definition Output.h:21

Output::POINTS
@ POINTS
Definition Output.h:21

Output::writeResultInStep
void writeResultInStep(int resultSteps, vector< Particle * > *particles, double iTime)
Write results if the step is the step result.

Output::writeSTLContactInStep
void writeSTLContactInStep(int resultSteps, TerrainContact *tc, double iTime)
Write the STL contact results if the step is the step result.

Output::configureSTLContactFields
void configureSTLContactFields(vector< string > fields)
Configures the stlContact fields to be written.

Output::farewellScreen
void farewellScreen()
Print final program screen.

Output::printElapsedTime
void printElapsedTime()
Print elapsed time.

Output::writeInitialState
void writeInitialState(vector< Body * > *bodies, double iTime, Mesh *mesh, TerrainContact *tc)
Write the initial state of the simulation.

Output::isGridFieldRequired
bool isGridFieldRequired(string field)
Verify is the field must be written.

Output::configureGridResultFields
void configureGridResultFields(vector< string > fields)
Configures the grid fields to be written.

Output::isFieldRequired
bool isFieldRequired(string field)
Verify is the grid field must be written.

Output::writeGrid
void writeGrid(Mesh *mesh, CellType cell_type_representation=CellType::CELLS, double time=0.0)
Write the grid mesh into a vtu file.

Output::writeGridInStep
void writeGridInStep(int resultSteps, Mesh *mesh, double iTime)
Write grid results if the step is the step result.

Output::writeParticles
void writeParticles(vector< Particle * > *particles, double time=0.0)
Write the particles of the model into a vtu file.

Output::writeResultsSeries
void writeResultsSeries()
Write the time series of the results.

Output::writeBodies
void writeBodies(vector< Body * > *bodies, double time=0.0)
Write the particles forming bodies.

Output::welcomeScreen
void welcomeScreen()
Print initial program screen.

Output::configureResultFields
void configureResultFields(vector< string > fields)
Configures the fields to be written.