itasca.zone

Functions and classes for working with FLAC zones.

Functions

itasca.zone.containing(point: vec, search_start=None) → Zone object or None.: Get the zone that contains point. The optional argument search_start can be given to first search the a given zone. This can speed up the check.

itasca.zone.create_ratio(ratio: float, index: int, isize: int) → float.: Get a value calculated by a geometric progression, given a ratio, an index, and a size. This is the same ratio as is used in the zone create logic, the Sketch, and Building-Blocks. This divides the interval from 0.0 to 1.0 into size sections each of which is ratio times the size of the previous one. \(ratio\) is the geometric ratio to use for the progression. Each interval will be ratio times larger than the previous. \(index\) is the index (from 0 to size) of the location in the progression to calculate. \(isize\) is the total number of intervals involved. The return value is the fraction from 0.0 to 1.0 of the geometric progression from 0 to size at index of the given ratio.

itasca.zone.creep_time_total() → float.: Get the total accumulated zone module creep time. This accumulates the timesteps of every cycle the zone creep module is active.

itasca.zone.creep_timestep() → float.: Get the timestep used by the zone creep module when it is active. This may not be the timestep used, as other active modules may require a smaller timestep.

itasca.zone.dynamic_time_total() → float.: Get the total accumulated zone module dynamic time. This accumulates the timesteps of every cycle the zone dynamic module is active.

itasca.zone.dynamic_timestep() → float.: Get the total accumulated zone module creep time. This accumulates the timesteps of every cycle the zone creep module is active.

itasca.zone.find(id: int) → Zone object.: Get the zone object with the given ID number.

itasca.zone.fluid_ratio() → float.: Get the current fluid convergence ratio for zones. This is defined as the ratio of total unbalanced flow to the total flow through the zones.

itasca.zone.fluid_stress_normal() → float.: Get the current maximum value of convergence in any gridpoint in the model. See the model.solve.convergence keyword.

itasca.zone.fluid_time_total() → float.: Get the total accumulated zone module fluid time. This accumulates the timesteps of every cycle the zone fluid module is active.

itasca.zone.fluid_timestep() → float.: Get the current fluid timestep. Note that this may not be the timestep used in a cycle, if other modules require a smaller one. This may be overriden by automatic timestep calculations, if active. Fixing a timestep greater than the calculated critical value will produce an error.

itasca.zone.fluid_unbal_avg() → float.: Get the average unbalanced fluid volume limit for the fastflow solution scheme.

itasca.zone.fluid_unbal_max() → float.: Get the maximum unbalanced fluid limit for the fastflow solution scheme.

itasca.zone.force_update() → None.: Flags the cycling logic so that a geometry update is performed at the start of the next cycle. Normally this update is performed at the start of cycling, and in large strain model at the geometry update interval. Changes to gridpoint mass and gravity caused by density and stiffness changes may not actually affect the calculation unless an update is performed.

itasca.zone.mech_convergence() → float.: Get the current maximum value of convergence in any gridpoint in the model. See the model.solve.convergence keyword.

itasca.zone.mech_ratio() → float.: Get the current zone mechanical convergence ratio. See the zone ratio command.

itasca.zone.mech_ratio_avg() → float.: Get the current zone mechanical average convergence ratio. See the zone ratio command.

itasca.zone.mech_ratio_local() → float.: Get the current zone mechanical local convergence ratio. See the zone ratio command.

itasca.zone.mech_ratio_max() → float.: Get the current zone mechanical local convergence ratio. See the zone ratio command.

itasca.zone.near(point: vec) → Zone object.: Find the closest zone to a point.

itasca.zone.set_creep_time_total(value: float) → None.: Set the total accumulated zone module creep time. This accumulates the timesteps of every cycle the zone creep module is active.

itasca.zone.set_creep_timestep(value: float) → None.: Set the timestep used by the zone creep module when it is active. This may not be the timestep used, as other active modules may require a smaller timestep.

itasca.zone.set_dynamic_time_total(value: float) → None.: Set the total accumulated zone module dynamic time. This accumulates the timesteps of every cycle the zone dynamic module is active.

itasca.zone.set_dynamic_timestep(value: float) → None.: Set the total accumulated zone module creep time. This accumulates the timesteps of every cycle the zone creep module is active.

itasca.zone.set_fluid_time_total(value: float) → None.: Set the total accumulated zone module fluid time. This accumulates the timesteps of every cycle the zone fluid module is active.

itasca.zone.set_fluid_timestep(value: float) → None.: Set the current fluid timestep. Note that this may not be the timestep used in a cycle, if other modules require a smaller one. This may be overriden by automatic timestep calculations, if active. Fixing a timestep greater than the calculated critical value will produce an error.

itasca.zone.set_thermal_time_total(value: float) → None.: Set the total accumulated zone module thermal time. This accumulates the timesteps of every cycle the zone thermal module is active.

itasca.zone.set_thermal_timestep(value: float) → None.: Set the current thermal timestep. Note that this may not be the timestep used in a cycle, if other modules require a smaller one. This may be overriden by automatic timestep calculations, if active. Fixing a timestep greater than the calculated critical value will produce an error.

itasca.zone.thermal_time_total() → float.: Get the total accumulated zone module thermal time. This accumulates the timesteps of every cycle the zone thermal module is active.

itasca.zone.thermal_timestep() → float.: Get the current thermal timestep. Note that this may not be the timestep used in a cycle, if other modules require a smaller one. This may be overriden by automatic timestep calculations, if active. Fixing a timestep greater than the calculated critical value will produce an error.

itasca.zone.unbal() → float.: Get the current maximum unbalanced force on any gridpoint in the model.

Classes

⇄

⇐ itasca.vertexarray | Zone ⇒

Updated: Sep 26, 2024