CFDElement

class itasca.element.cfd.CFDElement

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

adjacent_to_face(index) → CFD element object.

Get the element adjacent to the face with identifier index.

density() → float.

Get the CFD element fluid density.

drag_force() → vec.

Get the CFD element fluid drag force (vector).

drag_force_x() → float.

Get the x-component of the CFD element fluid drag force.

drag_force_y() → float.

Get the y-component of the CFD element fluid drag force.

drag_force_z() → float.

Get the z-component of the CFD element fluid drag force.

extra(slot: int) → any.

Get the CFD element extra data in the given slot.

group([slot: str or int]) → str.

Get the CFD element group name in a given slot.

group_remove(group_name: str or int[, slot: str or int]) → bool.

Remove from the given group from all group slots of the CFD element. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this CFD element is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the CFD element id.

in_group(group_name: str or int[, slot: str or int]) → bool.

Test if the CFD element is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

node_pos(index) → vec.

Get the position of node with identifier index (vector).

node_pos_x(index) → float.

Get the x-component of the position of node with identifier index.

node_pos_y(index) → float.

Get the y-component of the position of node with identifier index.

node_pos_z(index) → float.

Get the z-component of the position of node with identifier index.

porosity() → float.

Get the CFD element fluid porosity.

pos() → vec.

Get the CFD element location (vector).

pos_x() → float.

Get the x-component of the CFD element location.

pos_y() → float.

Get the y-component of the CFD element location.

pos_z() → float.

Get the z-component of the CFD element location.

pres_grad() → vec.

Get the CFD element fluid pressure gradient (vector).

pres_grad_x() → float.

Get the x-component of the CFD element fluid pressure gradient.

pres_grad_y() → float.

Get the y-component of the CFD element fluid pressure gradient.

pres_grad_z() → float.

Get the z-component of the CFD element fluid pressure gradient.

pressure() → float.

Get the CFD element fluid_pressure.

set_density(value: float) → None.

Set the CFD element fluid density.

set_drag_force(value: vec) → None.

Set the CFD element fluid drag force (vector).

set_drag_force_x(value: float) → None.

Set the x-component of the CFD element fluid drag force.

set_drag_force_y(value: float) → None.

Set the y-component of the CFD element fluid drag force.

set_drag_force_z(value: float) → None.

Set the z-component of the CFD element fluid drag force.

set_extra(slot: int, value: any) → None.

Set the CFD element extra data in the given slot.

set_group(group_name: str or int[, slot: str or int]) → None.

Set the CFD element group name in a given slot.

set_porosity(value: float) → None.

Set the CFD element fluid porosity.

set_pres_grad(value: vec) → None.

Set the CFD element fluid pressure gradient (vector).

set_pres_grad_x(value: float) → None.

Set the x-component of the CFD element fluid pressure gradient.

set_pres_grad_y(value: float) → None.

Set the y-component of the CFD element fluid pressure gradient.

set_pres_grad_z(value: float) → None.

Set the z-component of the CFD element fluid pressure gradient.

set_pressure(value: float) → None.

Set the CFD element fluid_pressure.

set_vel(value: vec) → None.

Set the CFD element fluid velocity (vector).

set_vel_x(value: float) → None.

Set the x-component of the CFD element fluid velocity.

set_vel_y(value: float) → None.

Set the y-component of the CFD element fluid velocity.

set_vel_z(value: float) → None.

Set the z-component of the CFD element fluid velocity.

set_viscosity(value: float) → None.

Set the CFD element fluid viscosity.

share_a_face() → tuple of CFD element objects.

Get all elements that share a face with this element.

share_a_node() → tuple of CFD element objects.

Get all elements that share a node with this element.

share_an_edge() → tuple of CFD element objects.

Get all elements that share an edge with this element.

valid() → bool.

Returns True if this CFD element is live.

vel() → vec.

Get the CFD element fluid velocity (vector).

vel_x() → float.

Get the x-component of the CFD element fluid velocity.

vel_y() → float.

Get the y-component of the CFD element fluid velocity.

vel_z() → float.

Get the z-component of the CFD element fluid velocity.

viscosity() → float.

Get the CFD element fluid viscosity.

vol() → float.

Get the CFD element volume.