v_sim.Pointset¶

Implementations:: v_sim.Data, v_sim.ScalarField

Methods¶

	`applyTranslation` ()
	`getTranslation` ()
	`getTranslationPeriodicStatus` ()
	`setBoxTranslation` (boxTrans, withModulo)
	`setInTheBox` (status)
	`setTranslation` (trans, withModulo)
	`setTranslationActive` (status)
	`setTranslationPeriodic` (trans, withModulo)
	`shift` (delta, withModulo)

Virtual Methods¶

	`do_apply_translation` ()
	`do_get_translation` (translation)
	`do_set_inTheBox` (status)
	`do_set_translation` (translation, withModulo)
	`do_set_translationActive` (status)

Properties¶

Name	Type	Flags	Short Description
`in-the-box`	`bool`	r/w	All nodes are constrained in the box
`reduced-translation`		r/w	Translations along box axis
`translation`		r/w	Translations along all axis
`use-translation`	`bool`	r/w	Use translations along all axis

Signals¶

None

Fields¶

None

Class Details¶

class v_sim.Pointset¶

Bases:: GObject.GInterface
Structure:: v_sim.PointsetInterface

Interface object.

New in version 3.8.

applyTranslation()¶: Apply all the translation (node and box) on each node coordinates and reset both translations to zero.

New in version 3.8.

getTranslation()¶

Returns:: a location to store the translation values.
Return type:: trans: [float]

Retrieves the translations of self.

New in version 3.8.

getTranslationPeriodicStatus()¶

Returns:: True if any of the translation in the periodic boundary conditions are not null.
Return type:: bool

Tests if any of the translation in the periodic boundary conditions are not null.

New in version 3.8.

setBoxTranslation(boxTrans, withModulo)¶

Parameters:

boxTrans ([float]) – an array of floating point values.
withModulo (bool) – a boolean.

Returns:

True if any translations have been changed.

Return type:

bool

This sets the translations of the specified v_sim.Pointset only along periodic axis. The translation boxTrans gives normalized values along all box axis. Points are also constrainted inside the box in the periodic directions if withModulo is True.

New in version 3.8.

setInTheBox(status)¶

Parameters:: status (bool) – a boolean.
Returns:: True, if any node has changed position.
Return type:: bool

Update all node positions inside self to be constrained inside the box (status is True), or release all previous position shift to original position without constrain (status is False).

New in version 3.8.

setTranslation(trans, withModulo)¶

Parameters:

trans ([float]) – the translations.
withModulo (bool) – a boolean.

Returns:

False pointset was already pointset with the v_sim.Box of box.

Return type:

bool

Apply the given translation values to self. If withModulo is given, all points inside the pointset will be shifted inside the periodic cell.

New in version 3.8.

setTranslationActive(status)¶

Parameters:: status (bool) – a boolean.
Returns:: True if status is changed.
Return type:: bool

Set the if the translations are applied or not to self.

New in version 3.8.

setTranslationPeriodic(trans, withModulo)¶

Parameters:

trans ([float]) – an array of floating point values.
withModulo (bool) – a boolean.

Returns:

True if any translations have been changed.

Return type:

bool

This sets the translations of the specified v_sim.Pointset only in periodic boundary conditions. Points are also constrainted inside the box in the periodic directions if withModulo is True.

shift(delta, withModulo)¶

Parameters:

delta ([float]) – a translation.
withModulo (bool) – a boolean.

Returns:

True if translation is changed.

Return type:

bool

Shift the translation by delta.

New in version 3.8.

do_apply_translation() virtual¶: a routine to apply the stored translations.

do_get_translation(translation) virtual¶

Parameters:: translation (float) –

a routine to get the current translation status.

do_set_inTheBox(status) virtual¶

Parameters:: status (bool) –
Return type:: bool

a routine to translate every content in the box.

do_set_translation(translation, withModulo) virtual¶

Parameters:

translation (float) –
withModulo (bool) –

Return type:

bool

a routine to set the translation status.

do_set_translationActive(status) virtual¶

Parameters:: status (bool) –
Return type:: bool

a routine to activate or not the translation.

Property Details¶

v_sim.Pointset.props.in_the_box¶

Name:: in-the-box
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

All nodes are constrained in the box

v_sim.Pointset.props.reduced_translation¶

Name:: reduced-translation
Type:
Default Value:: None
Flags:: READABLE, WRITABLE

Translations along box axis

v_sim.Pointset.props.translation¶

Name:: translation
Type:
Default Value:: None
Flags:: READABLE, WRITABLE

Translations along all axis

v_sim.Pointset.props.use_translation¶

Name:: use-translation
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Use translations along all axis