StaDump is an abstract class whose subclasses read a Lammps' dump file. More...

#include <sta_dump.h>

Inheritance diagram for StaDump:

Collaboration diagram for StaDump:

Public Member Functions
	StaDump (const Str &filepath_, const int timestep_)
	Constructor of StaDump class. More...

Public Member Functions inherited from Starter
	Updater ()=default
	Constructor of Updater class. More...

Public Member Functions inherited from Updater
	Updater ()=default
	Constructor of Updater class. More...

void	compute (const ElPtr &elem, const int elementid, Json &data)
	Managing computation to update Element::data. More...

void	remove_from_skippable_elementids (const int elementid)
	Remove Element::elementid from skippable_elementids. More...

const ShPtr< Generator > &	get_ext_generator ()
	Get ext_generator of this object. More...

Protected Attributes
int	timestep

Str	filepath

Protected Attributes inherited from Updater
ShPtr< Generator >	ext_generator

Additional Inherited Members
Protected Member Functions inherited from Starter
virtual void	compute_body (const ElPtr &elem, Json &data) override
	Compute or parse properties and set them to Element::data given as a mutable reference. More...

Protected Member Functions inherited from Updater
virtual void	compute_common (const ElPtr &elem, Json &data)
	Common part of compute_body. More...

virtual void	compute_impl (Json &data, JsonToVoidFunc check_required_keys, JsonToBoolFunc check_optional_keys)=0
	Implementation of computation updating Element::data. More...

Static Protected Attributes inherited from Starter
static const bool	do_sorting_by_id = true

Detailed Description

StaDump is an abstract class whose subclasses read a Lammps' dump file.

This class inherits Starter class. This class is an abstract class and has a pure virtual function, StaDump::compute_impl.

Definition at line 21 of file sta_dump.h.

Constructor & Destructor Documentation

◆ StaDump()

StaDump::StaDump	(	const Str &	filepath_,
		const int	timestep_
	)

Constructor of StaDump class.

Parameters

filepath_	A path to a Lammps' dump file to be read. This parameter is assigned to filepath.
timestep_	A timestep of simulation to be read. This parameter is assigned to timestep.

Definition at line 13 of file sta_dump.cpp.

Member Data Documentation

◆ filepath

Str StaDump::filepath

protected

A path to a Lammps' dump file to be read.

Definition at line 33 of file sta_dump.h.

◆ timestep

int StaDump::timestep

protected

A timestep of simulation to be read. In a Lammps' dump file, this value is printed below the line saying ITEM: TIMESTEP. This member is useful to read one timestep from a Lammps' dump file containing multiple timesteps.

Definition at line 29 of file sta_dump.h.

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

src/starters/sta_dump.h
src/starters/sta_dump.cpp

Public Member Functions