v_sim.NodeValuesVector¶
- Subclasses:
Methods¶
- Inherited:
v_sim.NodeValuesFarray (15), v_sim.NodeValues (16), GObject.Object (37)
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
|
Properties¶
- Inherited:
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
Class Details¶
- class v_sim.NodeValuesVector(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Common name to refer to a #_VisuNodeValuesVector.
- classmethod new(arr, label)¶
- Parameters:
arr (
v_sim.NodeArray) – av_sim.NodeArrayobject.label (
str) – a translatable label.
- Returns:
a newly created
v_sim.NodeValuesVectorobject.- Return type:
Create a new vector field located on nodes.
New in version 3.8.
- getAt(node)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodeobject.- Returns:
the coordinates of vector for node.
- Return type:
[
float]
Retrieves the vector hosted on node.
New in version 3.8.
- getAtIterSpherical(iter)¶
- Parameters:
iter (
v_sim.NodeValuesIter) – av_sim.NodeValuesIterobject.- Returns:
the spherical coordinates.
- Return type:
Retrieves the vector hosted on iter in spherical coordinates.
New in version 3.8.
- getAtSpherical(node)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodeobject.- Returns:
the spherical coordinates.
- Return type:
Retrieves the vector hosted on node in spherical coordinates.
New in version 3.8.
- getShift(node)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodepointer.- Returns:
a vector location.
- Return type:
dxyz: [
float]
Get the shift value that is applied to every vector of self.
New in version 3.8.
- set(data)¶
- Parameters:
data ([
float]) – some vector coordinates.- Returns:
Trueif data has the same size as self.- Return type:
Assigns the coordinates stored in data to each nodes in self.
New in version 3.8.
- setAt(node, dxyz)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodeobject.dxyz ([
float]) – vector coordinates.
- Returns:
Trueif vector for node is indeed changed.- Return type:
Changes the vector hosted at node for one of coordinates defined by dxyz.
New in version 3.8.
- setAtDbl(node, dxyz)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodeobject.dxyz ([
float]) – vector coordinates.
- Returns:
Trueif vector for node is indeed changed.- Return type:
Same as
v_sim.NodeValuesVector.setAt() but for double values.New in version 3.8.
- setAtSpherical(node, sph)¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodeobject.sph ([
float]) – spherical coordinates.
- Returns:
Trueif vector for node is indeed changed.- Return type:
Same as
v_sim.NodeValuesVector.setAt() but using a spherical coordinate description.New in version 3.8.
- do_shift(node, dxyz) virtual¶
- Parameters:
node (
v_sim.Node) – av_sim.Nodepointer:dxyz ([
float]) – a shift in cartesian coordinates.
a routine to add a shift on each node.