Flow123d  jenkins-Flow123d-windows32-release-multijob-51
Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
OutputMSH Class Reference

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

#include <output_msh.h>

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

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
 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")
 
 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, const Input::Type::Selection &in_sel)
 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)
 
template<int spacedim, class Value >
void register_data (const Input::Record &in_rec, const RefType type, MultiField< spacedim, Value > &multi_field)
 
template<int spacedim, class Value >
void register_data (const Input::Record &in_rec, const RefType ref_type, Field< spacedim, Value > &field_ref)
 

Static Public Attributes

static Input::Type::Record input_type
 The definition of input record for gmsh file format. More...
 
- Static Public Attributes inherited from OutputTime
static Input::Type::Record input_type
 The specification of output stream. More...
 
static Input::Type::AbstractRecord input_format_type
 The specification of output file format. 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, OutputDataBase *output_data)
 This function writes continuous ascii data to GMSH (.msh) output file. More...
 
void write_msh_ascii_discont_data (OutputDataBase *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...
 

Private Attributes

bool header_written
 

Additional Inherited Members

- Public Types inherited from OutputTime
enum  DiscreteSpace { NODE_DATA = 0, CORNER_DATA = 1, ELEM_DATA = 3 }
 
- Static Public Member Functions inherited from OutputTime
static void destroy_all (void)
 Try to find output stream from a key in record. More...
 
static OutputTimecreate_output_stream (const Input::Record &in_rec)
 This method write all registered data to output streams. More...
 
- Protected Types inherited from OutputTime
enum  OutFileFormat { NONE = 0, GMSH = 1, VTK = 2 }
 
typedef enum
OutputTime::OutFileFormat 
OutFileFormat
 
- Protected Member Functions inherited from OutputTime
template<int spacedim, class Value >
void compute_field_data (DiscreteSpace space, Field< spacedim, Value > &field)
 
OutputDataBaseoutput_data_by_field_name (const string &field_name, DiscreteSpace ref_type)
 This method returns pointer at existing data, when corresponding output data exists or it creates new one. More...
 
void set_data_time (void *data, double time)
 This method set current time for registered data array/vector. More...
 
string * base_filename ()
 
ofstream & get_base_file (void)
 
ofstream & get_data_file (void)
 
string & get_data_filename (void)
 
Meshget_mesh (void)
 
unsigned int get_corner_count (void)
 
void set_data_file (ofstream *_data_file)
 
void set_mesh (Mesh *_mesh)
 
void set_base_file (ofstream *_base_file)
 
- Protected Attributes inherited from OutputTime
int rank
 MPI rank of process (is tested in methods) More...
 
OutFileFormat file_format
 
vector< OutputDataBase * > node_data
 
vector< OutputDataBase * > corner_data
 
vector< OutputDataBase * > elem_data
 
int current_step
 Current step. More...
 
double time
 The newest time of registered data. More...
 
double write_time
 The last time, when data was wrote to this stream. More...
 
map< string, bool > output_names
 Map of names of output fields. True means that field will be saved. More...
 
Input::Record input_record_
 
- Static Protected Attributes inherited from OutputTime
static std::vector< OutputTime * > output_streams
 Vector of pointers at OutputTime. More...
 

Detailed Description

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

Definition at line 38 of file output_msh.h.

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 268 of file output_msh.cc.

OutputMSH::~OutputMSH ( )

The destructor of this class.

Definition at line 274 of file output_msh.cc.

Member Function Documentation

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 242 of file output_msh.cc.

int OutputMSH::write_head ( void  )
virtual

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

Returns
This function returns 1

Implements OutputTime.

Definition at line 227 of file output_msh.cc.

template<class element >
void OutputMSH::write_msh_ascii_cont_data ( flow::VectorId< element > &  vec,
OutputDataBase 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 93 of file output_msh.cc.

void OutputMSH::write_msh_ascii_discont_data ( OutputDataBase 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 111 of file output_msh.cc.

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 194 of file output_msh.cc.

void OutputMSH::write_msh_geometry ( void  )
private

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

Definition at line 54 of file output_msh.cc.

void OutputMSH::write_msh_header ( void  )
private

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

Definition at line 44 of file output_msh.cc.

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 135 of file output_msh.cc.

void OutputMSH::write_msh_topology ( void  )
private

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

Definition at line 68 of file output_msh.cc.

int OutputMSH::write_tail ( void  )
virtual

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

Implements OutputTime.

Definition at line 263 of file output_msh.cc.

Here is the caller graph for this function:

Member Data Documentation

bool OutputMSH::header_written
private

Was header already written to output file?

Definition at line 91 of file output_msh.h.

Record OutputMSH::input_type
static
Initial value:
= Record("gmsh", "Parameters of gmsh output format.")

The definition of input record for gmsh file format.

Definition at line 59 of file output_msh.h.


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