AddWrappedPosition adds wrapped positions for an Element object. More...

Inheritance diagram for AddWrappedPosition:

Collaboration diagram for AddWrappedPosition:

Public Member Functions
	AddWrappedPosition (const ElPtr &elem)
	Constructor of AddWrappedPosition class. More...

Public Member Functions inherited from Adder
	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 Adder
virtual void	compute_body (const ElPtr &elem, Json &data) override
	Compute properties and add 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 Updater
ShPtr< Generator >	ext_generator

Detailed Description

AddWrappedPosition adds wrapped positions for an Element object.

Wrapping is a process to resolve periodic boundary condition; wrapped positions are in the original simulation box.

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

Definition at line 24 of file add_wrapped_position.h.

Constructor & Destructor Documentation

AddWrappedPosition::AddWrappedPosition ( const ElPtr & elem )

Constructor of AddWrappedPosition class.

Parameters

elem	An Element object for a simulation box. This parameter is assigned to ext_generator. Required property `lo_x` : float `lo_y` : float `lo_z` : float `hi_x` : float `hi_y` : float `hi_z` : float

Definition at line 13 of file add_wrapped_position.cpp.

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

overrideprotectedvirtual

This method overrides Updater::compute_impl.

Property to be added

Required property

Implements Updater.

Definition at line 21 of file add_wrapped_position.cpp.

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