StaDumpBox reads a Lammps' dump file and sets properties for simulation box. More...

#include <sta_dump_box.h>

Inheritance diagram for StaDumpBox:

Collaboration diagram for StaDumpBox:

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

Public Member Functions inherited from StaDump
	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 Member Functions
virtual void	compute_impl (Json &data, JsonToVoidFunc check_required_keys, JsonToBoolFunc check_optional_keys) override
	This method overrides Updater::compute_impl. More...

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...

Additional Inherited Members
Protected Attributes inherited from StaDump
int	timestep

Str	filepath

Protected Attributes inherited from Updater
ShPtr< Generator >	ext_generator

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

Detailed Description

StaDumpBox reads a Lammps' dump file and sets properties for simulation box.

An object of this class reads properties of simulation box from a Lammps' dump file specified by filepath. Note that only properties at a time specified by timestep are read.

About usage in Python, please see pybind::py_sta_dump_box.

Definition at line 25 of file sta_dump_box.h.

Member Function Documentation

◆ compute_impl()

void StaDumpBox::compute_impl	(	Json &	data,
		JsonToVoidFunc	check_required_keys,
		JsonToBoolFunc	check_optional_keys
	)

overrideprotectedvirtual

This method overrides Updater::compute_impl.

Property to be added

pbc_x : boolean
pbc_y : boolean
pbc_z : boolean
lo_x : float
lo_y : float
lo_z : float
hi_x : float
hi_y : float
hi_z : float

Implements Updater.

Definition at line 19 of file sta_dump_box.cpp.

Here is the call graph for this function:

◆ StaDump()

StaDump::StaDump

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.

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

src/starters/sta_dump_box.h
src/starters/sta_dump_box.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compute_impl()

◆ StaDump()