Writing in UCD format. More...

Inheritance diagram for Arcane::DumpWUCD:

Collaboration diagram for Arcane::DumpWUCD:

Public Member Functions
	DumpWUCD (ISubDomain sd, IMesh mesh, const String &filename, RealConstArrayView times, VariableCollection variables)
void	setMetaData (const String &meta_data) override
	Sets metadata information.
String	metaData () const
void	writeVal (IVariable &, ConstArrayView< Byte >) override
	Writing for variable v of array a.
void	writeVal (IVariable &, ConstArrayView< Real >) override
	Saving scalar variables. The variable is saved in a different stream depending on its origin (node or cell).
void	writeVal (IVariable &, ConstArrayView< Real2 >) override
void	writeVal (IVariable &, ConstArrayView< Real3 >) override
	Saving vector variables. The variable is saved in a different stream depending on its origin (node or cell).
void	writeVal (IVariable &, ConstArrayView< Int64 >) override
void	writeVal (IVariable &, ConstArrayView< Int32 >) override
void	writeVal (IVariable &, ConstArrayView< Real2x2 >) override
void	writeVal (IVariable &, ConstArrayView< Real3x3 >) override
void	writeVal (IVariable &, ConstArrayView< String >) override
void	writeVal (IVariable &, ConstArray2View< Byte >) override
void	writeVal (IVariable &, ConstArray2View< Real >) override
void	writeVal (IVariable &, ConstArray2View< Int64 >) override
void	writeVal (IVariable &, ConstArray2View< Int32 >) override
void	writeVal (IVariable &, ConstArray2View< Real2 >) override
void	writeVal (IVariable &, ConstArray2View< Real3 >) override
void	writeVal (IVariable &, ConstArray2View< Real2x2 >) override
void	writeVal (IVariable &, ConstArray2View< Real3x3 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Byte >) override
void	writeVal (IVariable &, ConstMultiArray2View< Real >) override
void	writeVal (IVariable &, ConstMultiArray2View< Int64 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Int32 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Real2 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Real3 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Real2x2 >) override
void	writeVal (IVariable &, ConstMultiArray2View< Real3x3 >) override
void	beginWrite () override
	Creation of the UCD file (named UCD_<no_iteration>) and its header. This header contains:
void	endWrite () override
	Concatenation of the stream containing cell data to the main file.
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::DumpW
	DumpW ()
	Constructor.
virtual	~DumpW ()
	Frees resources.
void	beginWrite (const VariableCollection &vars)
	Notifies the start of writing.
void	write (IVariable var, IData data)
	Writes the data data of the variable var.
Public Member Functions inherited from Arcane::IDataWriter
virtual	~IDataWriter ()=default
	Frees resources.

Private Attributes
ISubDomain *	m_sub_domain
IMesh *	m_mesh
	Mesh.
Directory	m_base_directory
	Storage directory name.
RealUniqueArray	m_times
	List of time instances.
VariableList	m_save_variables
	List of variables to export.
UniqueArray< Ref< OStringStream > >	m_cell_streams
	Variable values at cells.
UniqueArray< Ref< OStringStream > >	m_node_streams
	Variable values at nodes.
UniqueArray< Cell >	m_managed_cells
	List of managed cells.

Static Private Attributes
static constexpr Integer	m_max_digit = 5
static constexpr Integer	MAX_FLOAT_DIGIT = FloatInfo<Real>::maxDigit() + 1

Additional Inherited Members
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const
Protected Member Functions inherited from Arcane::DumpW
virtual void	writeVal (IVariable &, ConstArrayView< Int16 >)
virtual void	writeVal (IVariable &, ConstArray2View< Int16 >)
virtual void	writeVal (IVariable &, ConstMultiArray2View< Int16 >)

Detailed Description

Writing in UCD format.

Definition at line 67 of file DumpWUCD.cc.

Constructor & Destructor Documentation

◆ DumpWUCD()

Arcane::DumpWUCD::DumpWUCD	(	ISubDomain *	sd,
		IMesh *	mesh,
		const String &	filename,
		RealConstArrayView	times,
		VariableCollection	variables )

Definition at line 134 of file DumpWUCD.cc.

◆ ~DumpWUCD()

Arcane::DumpWUCD::~DumpWUCD ( )

Definition at line 181 of file DumpWUCD.cc.

Member Function Documentation

◆ beginWrite()

void Arcane::DumpWUCD::beginWrite ( )

overridevirtual

Creation of the UCD file (named UCD_<no_iteration>) and its header. This header contains:

number of nodes, number of cells...
node coordinates <cell definition

Note that the UCD format requires that node data precedes cell data of the cells. The cell data is therefore written into a temporary buffer and concatenated to the file at the end (writeEnd method).

Implements Arcane::DumpW.

Definition at line 269 of file DumpWUCD.cc.

References Arcane::TraceAccessor::info().

Here is the call graph for this function:

◆ endWrite()

void Arcane::DumpWUCD::endWrite ( )

overridevirtual

Concatenation of the stream containing cell data to the main file.

Implements Arcane::DumpW.

Definition at line 282 of file DumpWUCD.cc.

References Arcane::IVariable::dataType(), Arcane::TraceAccessor::debug(), Arcane::IVariable::dimension(), Arcane::DT_Real, Arcane::DT_Real3, Arcane::IK_Cell, Arcane::IK_Node, Arcane::TraceAccessor::info(), Arcane::IVariable::itemKind(), Arcane::Item::localId(), Arcane::String::localstr(), m_base_directory, m_cell_streams, m_managed_cells, m_mesh, m_node_streams, m_save_variables, m_times, Arcane::IVariable::name(), Arcane::ItemWithNodes::nbNode(), Arcane::ItemWithNodes::node(), Arcane::Item::type(), Arcane::Real3POD::x, Arcane::Real3POD::y, and Arcane::Real3POD::z.

Here is the call graph for this function:

◆ metaData()

String Arcane::DumpWUCD::metaData ( ) const

inline

Definition at line 81 of file DumpWUCD.cc.

◆ setMetaData()

void Arcane::DumpWUCD::setMetaData ( const String & meta_data )

inlineoverridevirtual

Sets metadata information.

Implements Arcane::DumpW.

Definition at line 77 of file DumpWUCD.cc.

◆ writeVal() [1/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Byte >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 93 of file DumpWUCD.cc.

◆ writeVal() [2/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Int32 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 96 of file DumpWUCD.cc.

◆ writeVal() [3/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Int64 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 95 of file DumpWUCD.cc.

◆ writeVal() [4/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Real >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 94 of file DumpWUCD.cc.

◆ writeVal() [5/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Real2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 97 of file DumpWUCD.cc.

◆ writeVal() [6/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Real2x2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 99 of file DumpWUCD.cc.

◆ writeVal() [7/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Real3 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 98 of file DumpWUCD.cc.

◆ writeVal() [8/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArray2View< Real3x3 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 100 of file DumpWUCD.cc.

◆ writeVal() [9/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	v,
		ConstArrayView< Byte >	a )

inlineoverridevirtual

Writing for variable v of array a.

Implements Arcane::DumpW.

Definition at line 83 of file DumpWUCD.cc.

◆ writeVal() [10/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< Int32 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 88 of file DumpWUCD.cc.

◆ writeVal() [11/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< Int64 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 87 of file DumpWUCD.cc.

◆ writeVal() [12/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	v,
		ConstArrayView< Real >	ptr )

overridevirtual

Saving scalar variables. The variable is saved in a different stream depending on its origin (node or cell).

Implements Arcane::DumpW.

Definition at line 194 of file DumpWUCD.cc.

References Arcane::IK_Cell, Arcane::IK_Node, Arcane::TraceAccessor::info(), Arcane::IVariable::itemKind(), Arcane::Item::localId(), m_cell_streams, m_managed_cells, m_node_streams, Arcane::IVariable::name(), and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ writeVal() [13/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< Real2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 85 of file DumpWUCD.cc.

◆ writeVal() [14/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< Real2x2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 89 of file DumpWUCD.cc.

◆ writeVal() [15/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	v,
		ConstArrayView< Real3 >	ptr )

overridevirtual

Saving vector variables. The variable is saved in a different stream depending on its origin (node or cell).

Implements Arcane::DumpW.

Definition at line 226 of file DumpWUCD.cc.

References Arcane::IK_Cell, Arcane::IK_Node, Arcane::TraceAccessor::info(), Arcane::IVariable::itemKind(), Arcane::Item::localId(), m_cell_streams, m_managed_cells, m_node_streams, Arcane::IVariable::name(), and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ writeVal() [16/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< Real3x3 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 90 of file DumpWUCD.cc.

◆ writeVal() [17/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstArrayView< String >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 91 of file DumpWUCD.cc.

◆ writeVal() [18/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Byte >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 102 of file DumpWUCD.cc.

◆ writeVal() [19/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Int32 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 105 of file DumpWUCD.cc.

◆ writeVal() [20/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Int64 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 104 of file DumpWUCD.cc.

◆ writeVal() [21/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Real >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 103 of file DumpWUCD.cc.

◆ writeVal() [22/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Real2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 106 of file DumpWUCD.cc.

◆ writeVal() [23/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Real2x2 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 108 of file DumpWUCD.cc.

◆ writeVal() [24/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Real3 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 107 of file DumpWUCD.cc.

◆ writeVal() [25/25]

void Arcane::DumpWUCD::writeVal	(	IVariable &	,
		ConstMultiArray2View< Real3x3 >	)

inlineoverridevirtual

Implements Arcane::DumpW.

Definition at line 109 of file DumpWUCD.cc.

Member Data Documentation

◆ m_base_directory

Directory Arcane::DumpWUCD::m_base_directory

private

Storage directory name.

Definition at line 122 of file DumpWUCD.cc.

Referenced by endWrite().

◆ m_cell_streams

UniqueArray<Ref<OStringStream> > Arcane::DumpWUCD::m_cell_streams

private

Variable values at cells.

Definition at line 126 of file DumpWUCD.cc.

Referenced by endWrite(), writeVal(), and writeVal().

◆ m_managed_cells

UniqueArray<Cell> Arcane::DumpWUCD::m_managed_cells

private

List of managed cells.

Definition at line 128 of file DumpWUCD.cc.

Referenced by endWrite(), writeVal(), and writeVal().

◆ m_max_digit

Integer Arcane::DumpWUCD::m_max_digit = 5

staticconstexprprivate

Definition at line 116 of file DumpWUCD.cc.

◆ m_mesh

IMesh* Arcane::DumpWUCD::m_mesh

private

Mesh.

Definition at line 121 of file DumpWUCD.cc.

Referenced by endWrite().

◆ m_node_streams

UniqueArray<Ref<OStringStream> > Arcane::DumpWUCD::m_node_streams

private

Variable values at nodes.

Definition at line 127 of file DumpWUCD.cc.

Referenced by endWrite(), writeVal(), and writeVal().

◆ m_save_variables

VariableList Arcane::DumpWUCD::m_save_variables

private

List of variables to export.

Definition at line 124 of file DumpWUCD.cc.

Referenced by endWrite().

◆ m_sub_domain

ISubDomain* Arcane::DumpWUCD::m_sub_domain

private

Definition at line 120 of file DumpWUCD.cc.

◆ m_times

RealUniqueArray Arcane::DumpWUCD::m_times

private

List of time instances.

Definition at line 123 of file DumpWUCD.cc.

Referenced by endWrite().

◆ MAX_FLOAT_DIGIT

Integer Arcane::DumpWUCD::MAX_FLOAT_DIGIT = FloatInfo<Real>::maxDigit() + 1

staticconstexprprivate

Definition at line 118 of file DumpWUCD.cc.

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

DumpWUCD.cc

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DumpWUCD()

◆ ~DumpWUCD()

Member Function Documentation

◆ beginWrite()

◆ endWrite()

◆ metaData()

◆ setMetaData()

◆ writeVal() [1/25]

◆ writeVal() [2/25]

◆ writeVal() [3/25]

◆ writeVal() [4/25]

◆ writeVal() [5/25]

◆ writeVal() [6/25]

◆ writeVal() [7/25]

◆ writeVal() [8/25]

◆ writeVal() [9/25]

◆ writeVal() [10/25]

◆ writeVal() [11/25]

◆ writeVal() [12/25]

◆ writeVal() [13/25]

◆ writeVal() [14/25]

◆ writeVal() [15/25]

◆ writeVal() [16/25]

◆ writeVal() [17/25]

◆ writeVal() [18/25]

◆ writeVal() [19/25]

◆ writeVal() [20/25]

◆ writeVal() [21/25]

◆ writeVal() [22/25]

◆ writeVal() [23/25]

◆ writeVal() [24/25]

◆ writeVal() [25/25]

Member Data Documentation

◆ m_base_directory

◆ m_cell_streams

◆ m_managed_cells

◆ m_max_digit

◆ m_mesh

◆ m_node_streams

◆ m_save_variables

◆ m_sub_domain

◆ m_times

◆ MAX_FLOAT_DIGIT