Function t8_forest_write_vtk_ext

Function Documentation

int t8_forest_write_vtk_ext(t8_forest_t forest, const char *fileprefix, const int write_treeid, const int write_mpirank, const int write_level, const int write_element_id, const int write_ghosts, const int write_curved, int do_not_use_API, const int num_data, t8_vtk_data_field_t *data)

Write the forest in a parallel vtu format.

Extended version. See

See also

t8_forest_write_vtk for the standard version of this function. Writes one master .pvtu file and each process writes in its own .vtu file. If linked and not otherwise specified, the VTK API is used. If the VTK library is not linked, an ASCII file is written. This may change in accordance with write_ghosts, write_curved and do_not_use_API, because the export of ghosts is not yet available with the VTK API and the export of curved elements is not available with the inbuilt function to write ASCII files. The function will for example still use the VTK API to satisfy write_curved, even if do_not_use_API is set to true. Forest must be committed when calling this function. This function is collective and must be called on each process.

See also

t8_forest_write_vtk .

Parameters:

  • forest – [in] The forest to write.

  • fileprefix – [in] The prefix of the files where the vtk will be stored. The master file is then fileprefix.pvtu and the process with rank r writes in the file fileprefix_r.vtu.

  • write_treeid – [in] If true, the global tree id is written for each element.

  • write_mpirank – [in] If true, the mpirank is written for each element.

  • write_level – [in] If true, the refinement level is written for each element.

  • write_element_id – [in] If true, the global element id is written for each element.

  • write_ghosts – [in] If true, each process additionally writes its ghost elements. For ghost element the treeid is -1.

  • write_curved – [in] If true, write the elements as curved element types from vtk.

  • do_not_use_API – [in] Do not use the VTK API, even if linked and available.

  • num_data – [in] Number of user defined double valued data fields to write.

  • data – [in] Array of t8_vtk_data_field_t of length num_data providing the user defined per element data. If scalar and vector fields are used, all scalar fields must come first in the array.

Returns:

True if successful, false if not (process local). See also