Flow123d  release_1.8.2-1603-g0109a2b
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
OutputMSH Class Reference

This class is used for output data to VTK file format. More...

#include <output_msh.hh>

Inheritance diagram for OutputMSH:
Inheritance graph
[legend]
Collaboration diagram for OutputMSH:
Collaboration graph
[legend]

Public Types

typedef OutputTime FactoryBaseType
 
- Public Types inherited from OutputTime
enum  DiscreteSpace { NODE_DATA = 0, CORNER_DATA = 1, ELEM_DATA = 2 }
 

Public Member Functions

 OutputMSH ()
 The constructor of this class. More...
 
 OutputMSH (const Input::Record &in_rec)
 The constructor of this class. More...
 
 ~OutputMSH ()
 The destructor of this class. More...
 
int write_head (void)
 This method writes head of GMSH (.msh) file format. More...
 
int write_data (void)
 This method writes data to GMSH (.msh) file format for current time. More...
 
int write_tail (void)
 This method should write tail of GMSH (.msh) file format. More...
 
- Public Member Functions inherited from OutputTime
 OutputTime ()
 Default constructor. Only for testing. More...
 
 OutputTime (const Input::Record &in_rec)
 Constructor of OutputTime object. It opens base file for writing. More...
 
virtual ~OutputTime ()
 Destructor of OutputTime. It doesn't do anything, because all necessary destructors will be called in destructor of Output. More...
 
template<int spacedim, class Value >
void register_data (const DiscreteSpace type, MultiField< spacedim, Value > &multi_field)
 Generic method for registering output data stored in MultiField. More...
 
template<int spacedim, class Value >
void register_data (const DiscreteSpace ref_type, Field< spacedim, Value > &field)
 Generic method for registering of output data stored in Field. More...
 
void write_time_frame ()
 
void add_admissible_field_names (const Input::Array &in_array)
 Registers names of output fields that can be written using this stream. More...
 
void clear_data (void)
 Clear data for output computed by method compute_field_data. More...
 
void mark_output_times (const TimeGovernor &tg)
 
 TYPEDEF_ERR_INFO (EI_FieldName, std::string)
 
 DECLARE_EXCEPTION (ExcOutputVariableVector,<< "Can not output field "<< EI_FieldName::qval<< " returning variable size vectors. Try convert to MultiField.\n")
 

Static Public Member Functions

static const Input::Type::Recordget_input_type ()
 The definition of input record for gmsh file format. More...
 
- Static Public Member Functions inherited from OutputTime
static const Input::Type::Recordget_input_type ()
 The specification of output stream. More...
 
static Input::Type::Abstractget_input_format_type ()
 The specification of output file format. More...
 
static std::shared_ptr< OutputTimecreate_output_stream (const Input::Record &in_rec)
 This method delete all object instances of class OutputTime stored in output_streams vector. More...
 

Private Member Functions

void write_msh_header (void)
 This function write header of GMSH (.msh) file format. More...
 
void write_msh_geometry (void)
 This function writes geometry (position of nodes) to GMSH (.msh) file format. More...
 
void write_msh_topology (void)
 This function writes topology (connection of nodes) to the GMSH (.msh) file format. More...
 
template<class element >
void write_msh_ascii_cont_data (flow::VectorId< element > &vec, OutputDataPtr output_data)
 This function writes continuous ascii data to GMSH (.msh) output file. More...
 
void write_msh_ascii_discont_data (OutputDataPtr output_data)
 This function writes discontinuous ascii data to GMSH (.msh) output file. More...
 
void write_msh_node_data (double time, int step)
 This function write all data on nodes to output file. This function is used for static and dynamic data. More...
 
void write_msh_elem_data (double time, int step)
 This function write all data on elements to output file. This function is used for static and dynamic data. More...
 
void fix_base_file_name (void)
 This method add right suffix to .msh GMSH file. More...
 

Private Attributes

bool header_written
 

Static Private Attributes

static const int registrar
 Registrar of class to factory. More...
 

Additional Inherited Members

- Public Attributes inherited from OutputTime
Input::AbstractRecord format_record_
 
- Static Public Attributes inherited from OutputTime
static const unsigned int N_DISCRETE_SPACES = 3
 
- Protected Types inherited from OutputTime
typedef std::shared_ptr< OutputDataBaseOutputDataPtr
 
typedef std::vector< OutputDataPtrOutputDataFieldVec
 
typedef unsigned int DiscreteSpaceFlags
 
- Protected Member Functions inherited from OutputTime
template<int spacedim, class Value >
void compute_field_data (DiscreteSpace type, Field< spacedim, Value > &field)
 
void fix_main_file_extension (std::string extension)
 
- Protected Attributes inherited from OutputTime
int rank
 
OutputDataFieldVec output_data_vec_ [N_DISCRETE_SPACES]
 
int current_step
 
double time
 
double write_time
 
std::map< std::string, DiscreteSpaceFlagsoutput_names
 
Input::Record input_record_
 
ofstream _base_file
 
string _base_filename
 
Mesh_mesh
 

Detailed Description

This class is used for output data to VTK file format.

Definition at line 27 of file output_msh.hh.

Member Typedef Documentation

Definition at line 29 of file output_msh.hh.

Constructor & Destructor Documentation

OutputMSH::OutputMSH ( )

The constructor of this class.

OutputMSH::OutputMSH ( const Input::Record in_rec)

The constructor of this class.

Definition at line 249 of file output_msh.cc.

OutputMSH::~OutputMSH ( )

The destructor of this class.

Definition at line 261 of file output_msh.cc.

Member Function Documentation

void OutputMSH::fix_base_file_name ( void  )
private

This method add right suffix to .msh GMSH file.

const Record & OutputMSH::get_input_type ( )
static

The definition of input record for gmsh file format.

Definition at line 29 of file output_msh.cc.

int OutputMSH::write_data ( void  )
virtual

This method writes data to GMSH (.msh) file format for current time.

Returns
This function returns 1

Implements OutputTime.

Definition at line 218 of file output_msh.cc.

int OutputMSH::write_head ( void  )

This method writes head of GMSH (.msh) file format.

Returns
This function returns 1

Definition at line 202 of file output_msh.cc.

Here is the caller graph for this function:

template<class element >
void OutputMSH::write_msh_ascii_cont_data ( flow::VectorId< element > &  vec,
OutputDataPtr  output_data 
)
private

This function writes continuous ascii data to GMSH (.msh) output file.

Parameters
[in]*out_dataThe pointer at structure storing pointer at own data.

Definition at line 89 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_ascii_discont_data ( OutputDataPtr  output_data)
private

This function writes discontinuous ascii data to GMSH (.msh) output file.

Parameters
[in]*out_dataThe pointer at structure storing pointer at own data.

Definition at line 105 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_elem_data ( double  time,
int  step 
)
private

This function write all data on elements to output file. This function is used for static and dynamic data.

Parameters
[in]timeThe time from start
[in]stepThe number of steps from start

Definition at line 175 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_geometry ( void  )
private

This function writes geometry (position of nodes) to GMSH (.msh) file format.

Definition at line 50 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_header ( void  )
private

This function write header of GMSH (.msh) file format.

Definition at line 40 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_node_data ( double  time,
int  step 
)
private

This function write all data on nodes to output file. This function is used for static and dynamic data.

Parameters
[in]timeThe time from start
[in]stepThe number of steps from start

Definition at line 128 of file output_msh.cc.

Here is the caller graph for this function:

void OutputMSH::write_msh_topology ( void  )
private

This function writes topology (connection of nodes) to the GMSH (.msh) file format.

Definition at line 64 of file output_msh.cc.

Here is the caller graph for this function:

int OutputMSH::write_tail ( void  )

This method should write tail of GMSH (.msh) file format.

It is stupid file format. It doesn't write anything special at the end of the file

Returns
This function returns 1

Definition at line 242 of file output_msh.cc.

Here is the caller graph for this function:

Member Data Documentation

bool OutputMSH::header_written
private

Definition at line 81 of file output_msh.hh.

const int OutputMSH::registrar
staticprivate
Initial value:
= Input::register_class< OutputMSH, const Input::Record & >("gmsh") +

Registrar of class to factory.

Definition at line 79 of file output_msh.hh.


The documentation for this class was generated from the following files: