Writing curves in the specific Arcane format. More...

Inheritance diagram for Arcane::ArcaneCurveWriter:

Collaboration diagram for Arcane::ArcaneCurveWriter:

Classes
class	Impl

Public Member Functions
	ArcaneCurveWriter (const ServiceBuildInfo &sbi)
virtual void	build ()
	Build-level construction of the service.
virtual void	beginWrite (const TimeHistoryCurveWriterInfo &infos)
	Notify the start of writing.
virtual void	endWrite ()
	Notify the end of writing.
virtual void	writeCurve (const TimeHistoryCurveInfo &infos)
	Write a curve.
virtual String	name () const
	Writer name.
virtual void	setOutputPath (const String &path)
	Base directory where curves will be written.
virtual String	outputPath () const
	Base directory where curves will be written.
Public Member Functions inherited from Arcane::BasicService
	~BasicService () override
	Releases resources.
virtual ISubDomain *	subDomain ()
Public Member Functions inherited from Arcane::AbstractService
	~AbstractService () override
	Destructor.
IServiceInfo *	serviceInfo () const override
	Access to service information. See IServiceInfo for details.
IBase *	serviceParent () const override
	Access to the base interface of main Arcane objects.
IService *	serviceInterface () override
	Returns the low-level IService interface of the service.
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::IService
virtual	~IService ()
	Releases resources.
Public Member Functions inherited from Arcane::MeshAccessor
	MeshAccessor (ISubDomain *sd)
	MeshAccessor (IMesh *mesh)
	MeshAccessor (const MeshHandle &mesh_handle)
Integer	nbCell () const
	Returns the number of cells in the mesh.
Integer	nbFace () const
	Returns the number of faces in the mesh.
Integer	nbEdge () const
	Returns the number of edges in the mesh.
Integer	nbNode () const
	Returns the number of nodes in the mesh.
VariableNodeReal3 &	nodesCoordinates () const
	Returns the coordinates of the mesh nodes.
NodeGroup	allNodes () const
	Returns the group containing all nodes.
EdgeGroup	allEdges () const
	Returns the group containing all edges.
FaceGroup	allFaces () const
	Returns the group containing all faces.
CellGroup	allCells () const
	Returns the group containing all cells.
FaceGroup	outerFaces () const
	Returns the group containing all boundary faces.
NodeGroup	ownNodes () const
	Returns the group containing all nodes specific to this domain.
CellGroup	ownCells () const
	Returns the group containing all cells specific to this domain.
FaceGroup	ownFaces () const
	Group containing all faces specific to this domain.
EdgeGroup	ownEdges () const
	Group containing all edges specific to this domain.
IMesh *	mesh () const
const MeshHandle &	meshHandle () const
Public Member Functions inherited from Arcane::CommonVariables
	CommonVariables (IModule *c)
	Constructs the references of the common variables for the module c.
	CommonVariables (IVariableMng *variable_mng)
	Constructs the references of the common variables for the manager variable_mng.
	CommonVariables (ISubDomain *sd)
	Constructs the references of the common variables for the subdomain sd.
virtual	~CommonVariables ()
	Releases resources.
Int32	globalIteration () const
	Current iteration number.
Real	globalTime () const
	Current time.
Real	globalOldTime () const
	Previous current time.
Real	globalFinalTime () const
	Final time of the simulation.
Real	globalDeltaT () const
	Current Delta T.
Real	globalCPUTime () const
	CPU time used (in seconds).
Real	globalOldCPUTime () const
	Previous CPU time used (in seconds).
Real	globalElapsedTime () const
	Clock time (elapsed) used (in seconds).
Real	globalOldElapsedTime () const
	Previous clock time (elapsed) used (in seconds).
Public Member Functions inherited from Arcane::ITimeHistoryCurveWriter2
virtual	~ITimeHistoryCurveWriter2 ()=default
	Release resources.

Private Member Functions
void	_writeHeader ()
template<typename T>
Int64	_write (ConstArrayView< T > values)

Private Attributes
ScopedPtrT< Impl >	m_p
Int32	m_version
String	m_output_path

Additional Inherited Members
Public Attributes inherited from Arcane::CommonVariables
VariableScalarInt32	m_global_iteration
	Current iteration.
VariableScalarReal	m_global_time
	Current time.
VariableScalarReal	m_global_deltat
	Global Delta T.
VariableScalarReal	m_global_old_time
	Time previous to the current time.
VariableScalarReal	m_global_old_deltat
	Delta T at the time previous to the global time.
VariableScalarReal	m_global_final_time
	Final time of the case.
VariableScalarReal	m_global_old_cpu_time
	Previous CPU time used (in seconds).
VariableScalarReal	m_global_cpu_time
	CPU time used (in seconds).
VariableScalarReal	m_global_old_elapsed_time
	Previous clock time used (in seconds).
VariableScalarReal	m_global_elapsed_time
	Clock time used (in seconds).
Protected Member Functions inherited from Arcane::BasicService
	BasicService (const ServiceBuildInfo &)
Protected Member Functions inherited from Arcane::AbstractService
	AbstractService (const ServiceBuildInfo &)
	Constructor from a ServiceBuildInfo.
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const
Protected Member Functions inherited from Arcane::IService
	IService ()
	Constructor.

Detailed Description

Writing curves in the specific Arcane format.

Todo: write documentation on the format.

Definition at line 39 of file ArcaneCurveWriter.cc.

Constructor & Destructor Documentation

◆ ArcaneCurveWriter()

Arcane::ArcaneCurveWriter::ArcaneCurveWriter ( const ServiceBuildInfo & sbi )

inline

Definition at line 61 of file ArcaneCurveWriter.cc.

◆ ~ArcaneCurveWriter()

Arcane::ArcaneCurveWriter::~ArcaneCurveWriter ( )

inline

Definition at line 65 of file ArcaneCurveWriter.cc.

Member Function Documentation

◆ _write()

template<typename T>

Int64 Arcane::ArcaneCurveWriter::_write ( ConstArrayView< T > values )

inlineprivate

Definition at line 87 of file ArcaneCurveWriter.cc.

◆ _writeHeader()

void Arcane::ArcaneCurveWriter::_writeHeader ( )

private

Definition at line 142 of file ArcaneCurveWriter.cc.

◆ beginWrite()

void Arcane::ArcaneCurveWriter::beginWrite ( const TimeHistoryCurveWriterInfo & infos )

virtual

Notify the start of writing.

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 120 of file ArcaneCurveWriter.cc.

References Arcane::TraceAccessor::info(), Arcane::TimeHistoryCurveWriterInfo::path(), Arcane::ConstArrayView< T >::size(), Arcane::TimeHistoryCurveWriterInfo::times(), and Arcane::TraceAccessor::traceMng().

Here is the call graph for this function:

◆ build()

virtual void Arcane::ArcaneCurveWriter::build ( void )

inlinevirtual

Build-level construction of the service.

This method is called right after the constructor.

Reimplemented from Arcane::AbstractService.

Definition at line 69 of file ArcaneCurveWriter.cc.

◆ endWrite()

void Arcane::ArcaneCurveWriter::endWrite ( )

virtual

Notify the end of writing.

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 170 of file ArcaneCurveWriter.cc.

References ARCANE_FATAL, and Arcane::TraceAccessor::info().

Here is the call graph for this function:

◆ name()

virtual String Arcane::ArcaneCurveWriter::name ( ) const

inlinevirtual

Writer name.

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 73 of file ArcaneCurveWriter.cc.

Referenced by writeCurve().

Here is the caller graph for this function:

◆ outputPath()

virtual String Arcane::ArcaneCurveWriter::outputPath ( ) const

inlinevirtual

Base directory where curves will be written.

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 75 of file ArcaneCurveWriter.cc.

◆ setOutputPath()

virtual void Arcane::ArcaneCurveWriter::setOutputPath ( const String & path )

inlinevirtual

Base directory where curves will be written.

If null, the directory specified during beginWrite() will be used.

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 74 of file ArcaneCurveWriter.cc.

◆ writeCurve()

void Arcane::ArcaneCurveWriter::writeCurve ( const TimeHistoryCurveInfo & infos )

virtual

Write a curve.

Curve info is provided by infos Values are in the array values. times and iterations contain respectively the time and the iteration number for each value. path contains the directory where the curves will be written

Implements Arcane::ITimeHistoryCurveWriter2.

Definition at line 201 of file ArcaneCurveWriter.cc.

References Arcane::String::clone(), Arcane::TimeHistoryCurveInfo::iterations(), name(), Arcane::TimeHistoryCurveInfo::name(), Arcane::XmlNode::setAttrValue(), Arcane::ConstArrayView< T >::size(), Arcane::TimeHistoryCurveInfo::subSize(), and Arcane::TimeHistoryCurveInfo::values().

Here is the call graph for this function:

Member Data Documentation

◆ m_output_path

String Arcane::ArcaneCurveWriter::m_output_path

private

Definition at line 81 of file ArcaneCurveWriter.cc.

◆ m_p

ScopedPtrT<Impl> Arcane::ArcaneCurveWriter::m_p

private

Definition at line 79 of file ArcaneCurveWriter.cc.

◆ m_version

Int32 Arcane::ArcaneCurveWriter::m_version

private

Definition at line 80 of file ArcaneCurveWriter.cc.

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

ArcaneCurveWriter.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArcaneCurveWriter()

◆ ~ArcaneCurveWriter()

Member Function Documentation

◆ _write()

◆ _writeHeader()

◆ beginWrite()

◆ build()

◆ endWrite()

◆ name()

◆ outputPath()

◆ setOutputPath()

◆ writeCurve()

Member Data Documentation

◆ m_output_path

◆ m_p

◆ m_version