Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ManualHdf5VariableReader Class Reference

Reading variables in HDF5 format. More...

Inheritance diagram for Arcane::ManualHdf5VariableReader:
Collaboration diagram for Arcane::ManualHdf5VariableReader:

Public Member Functions

 ManualHdf5VariableReader (const ServiceBuildInfo &sbi)
virtual void build ()
 Build-level construction of the service.
virtual void read (IVariable *var)
virtual void initialize (bool is_start)
 Initializes the reader.
virtual void updateVariables (Real wanted_time)
 Updates the variables for the time wanted_time.
virtual void setBaseDirectoryName (const String &path)
 Sets the path of the directory containing the data.
virtual void setBaseFileName (const String &path)
 Sets the name of the file containing the data.
virtual void setVariables (VariableCollection vars)
 Sets the list of variables that we wish to reread. This call must happen before initialize().
virtual Real2 timeInterval (IVariable *var)
 Time interval of values for the variable var. The data for the variable var exists for the times included between a.x and a.y with a having the value returned.
Public Member Functions inherited from Arcane::BasicService
 ~BasicService () override
 Releases resources.
virtual ISubDomainsubDomain ()
Public Member Functions inherited from Arcane::AbstractService
 ~AbstractService () override
 Destructor.
IServiceInfoserviceInfo () const override
 Access to service information. See IServiceInfo for details.
IBaseserviceParent () const override
 Access to the base interface of main Arcane objects.
IServiceserviceInterface () 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.
TraceAccessoroperator= (const TraceAccessor &rhs)
 Copy assignment operator.
virtual ~TraceAccessor ()
 Frees resources.
ITraceMngtraceMng () 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.
VariableNodeReal3nodesCoordinates () 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.
IMeshmesh () const
const MeshHandlemeshHandle () 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 Attributes

Hdf5VariableReaderHelper2m_helper
String m_directory_name
String m_base_file_name
UniqueArray< IVariable * > m_variables
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).

Additional Inherited Members

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

Reading variables in HDF5 format.

Definition at line 1169 of file Hdf5VariableReader.cc.

Constructor & Destructor Documentation

◆ ManualHdf5VariableReader()

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

Definition at line 1240 of file Hdf5VariableReader.cc.

◆ ~ManualHdf5VariableReader()

Arcane::ManualHdf5VariableReader::~ManualHdf5VariableReader ( )

Definition at line 1252 of file Hdf5VariableReader.cc.

Member Function Documentation

◆ build()

virtual void Arcane::ManualHdf5VariableReader::build ( void )
inlinevirtual

Build-level construction of the service.

This method is called right after the constructor.

Reimplemented from Arcane::AbstractService.

Definition at line 1180 of file Hdf5VariableReader.cc.

◆ initialize()

virtual void Arcane::ManualHdf5VariableReader::initialize ( bool is_start)
inlinevirtual

Initializes the reader.

is_start is true if we are at the start of the calculation.

Implements Arcane::IVariableReader.

Definition at line 1189 of file Hdf5VariableReader.cc.

References Arcane::Directory::file(), and Arcane::TraceAccessor::pwarning().

Here is the call graph for this function:

◆ read()

virtual void Arcane::ManualHdf5VariableReader::read ( IVariable * var)
inlinevirtual

Definition at line 1184 of file Hdf5VariableReader.cc.

◆ setBaseDirectoryName()

virtual void Arcane::ManualHdf5VariableReader::setBaseDirectoryName ( const String & path)
inlinevirtual

Sets the path of the directory containing the data.

Implements Arcane::IVariableReader.

Definition at line 1207 of file Hdf5VariableReader.cc.

◆ setBaseFileName()

virtual void Arcane::ManualHdf5VariableReader::setBaseFileName ( const String & filename)
inlinevirtual

Sets the name of the file containing the data.

Implements Arcane::IVariableReader.

Definition at line 1212 of file Hdf5VariableReader.cc.

◆ setVariables()

virtual void Arcane::ManualHdf5VariableReader::setVariables ( VariableCollection vars)
inlinevirtual

Sets the list of variables that we wish to reread. This call must happen before initialize().

Implements Arcane::IVariableReader.

Definition at line 1217 of file Hdf5VariableReader.cc.

◆ timeInterval()

virtual Real2 Arcane::ManualHdf5VariableReader::timeInterval ( IVariable * var)
inlinevirtual

Time interval of values for the variable var. The data for the variable var exists for the times included between a.x and a.y with a having the value returned.

This call is valid only after calling initialize().

Implements Arcane::IVariableReader.

Definition at line 1222 of file Hdf5VariableReader.cc.

◆ updateVariables()

virtual void Arcane::ManualHdf5VariableReader::updateVariables ( Real wanted_time)
inlinevirtual

Updates the variables for the time wanted_time.

Implements Arcane::IVariableReader.

Definition at line 1202 of file Hdf5VariableReader.cc.

Member Data Documentation

◆ m_base_file_name

String Arcane::ManualHdf5VariableReader::m_base_file_name

Definition at line 1233 of file Hdf5VariableReader.cc.

◆ m_directory_name

String Arcane::ManualHdf5VariableReader::m_directory_name

Definition at line 1232 of file Hdf5VariableReader.cc.

◆ m_helper

Hdf5VariableReaderHelper2* Arcane::ManualHdf5VariableReader::m_helper

Definition at line 1231 of file Hdf5VariableReader.cc.

◆ m_variables

UniqueArray<IVariable*> Arcane::ManualHdf5VariableReader::m_variables

Definition at line 1234 of file Hdf5VariableReader.cc.


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