Struct Settings

pub struct Settings { /* private fields */ }

A settings struct, used to define boundary conditions, loads, and elements.

Implementations

impl Settings

pub fn new(nelx: usize, nely: usize, volume_fraction: f64) -> Self

Specify the number of elements and volume fraction

use topopt::Settings;
Settings::new(60, 20, 0.5);

pub fn with_filter_radius(&mut self, filter_radius: f64) -> Self

Specify the filter radius. If not specified, the default value is 1.5.

pub fn with_penalty_weight(&mut self, penalty_weight: f64) -> Self

Specify the penalty weight. If not specified, the default value is 1.5.

pub fn with_active_elements(&mut self, mask: DMatrix<bool>) -> Self

Specify elements that must remain active (i.e., filled). The active element boolean mask must have shape nely × nelx.

pub fn with_passive_elements(&mut self, mask: DMatrix<bool>) -> Self

Specify elements that must remain passive (i.e., filled). The passive element boolean mask must have shape nely × nelx.

pub fn with_size(&mut self, nelx: usize, nely: usize) -> Self

Specify the dimensions of the domain.

pub fn with_random_initialization(&mut self) -> Self

Specify the dimensions of the domain.

impl Settings

Modifying the Boundary Conditions

This group of methods provides utilities for changing the boundary conditions. These methods are applied like so:

 let settings = Settings::new(120, 30, 0.5)
     .with_bottom_right_bc(false, true)
     .with_bottom_left_bc(false, true);

pub fn with_left_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the left side of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_right_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the right side of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_top_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the top side of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_bottom_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the bottom side of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_vertical_midline_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the vertical midline of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_horizontal_midline_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the horizontal midline of the domain. The arguments define whether or not the nodes are fixed in the x and y directions.

pub fn with_bottom_right_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the bottom right corner of the domain. The arguments define whether or not the node is fixed in the x and y directions.

pub fn with_bottom_left_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the bottom left corner of the domain. The arguments define whether or not the node is fixed in the x and y directions.

pub fn with_top_right_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the top right corner of the domain. The arguments define whether or not the node is fixed in the x and y directions.

pub fn with_top_left_bc(&mut self, x: bool, y: bool) -> Self

Apply a boundary condition to the top left corner of the domain. The arguments define whether or not the node is fixed in the x and y directions.

pub fn with_bc(&mut self, boundary: DMatrix<(bool, bool)>) -> Self

Specify loading at every node. This matrix must shape nely+1 × nelx+1, where each element is a tuple defining whether or not the node is fixed in x and y directions.

pub fn set_bc(&mut self, idx: usize, jdx: usize, x: bool, y: bool) -> Self

Set the boundary condition at a specific node. The arguments define the indices of the node to be loaded, and whether or not the node is fixed in the x and y directions.

impl Settings

Modifying the Load Case

This group of methods provides utilities for changing the load case. These methods are applied like so:

 let settings = Settings::new(120, 30, 0.5)
     .with_bottom_right_bc(false, true)
     .with_bottom_left_bc(false, true)
     .with_top_middle_load(0.0, -1.0);

pub fn with_bottom_right_load(&mut self, x: f64, y: f64) -> Self

Set a load at the bottom right corner of the domain. The argument define loads in the x and y directions.

pub fn with_bottom_left_load(&mut self, x: f64, y: f64) -> Self

Set a load at the bottom left corner of the domain. The argument define loads in the x and y directions.

pub fn with_top_right_load(&mut self, x: f64, y: f64) -> Self

Set a load at the top right corner of the domain. The argument define loads in the x and y directions.

pub fn with_top_left_load(&mut self, x: f64, y: f64) -> Self

Set a load at the top left corner of the domain. The argument define loads in the x and y directions.

pub fn with_top_middle_load(&mut self, x: f64, y: f64) -> Self

Set a load at the middle of the top side of the domain. The argument define loads in the x and y directions.

pub fn with_bottom_middle_load(&mut self, x: f64, y: f64) -> Self

Set a load at the middle of the bottom side of the domain. The argument define loads in the x and y directions.

pub fn with_right_middle_load(&mut self, x: f64, y: f64) -> Self

Set a load at the middle of the right side of the domain. The argument define loads in the x and y directions.

pub fn with_left_middle_load(&mut self, x: f64, y: f64) -> Self

Set a load at the middle of the left side of the domain. The argument define loads in the x and y directions.

pub fn with_centered_load(&mut self, x: f64, y: f64) -> Self

Set a load at the center of the domain. The argument define loads in the x and y directions.

pub fn with_loads(&mut self, loads: DMatrix<(f64, f64)>) -> Self

Specify loading at every node. This matrix must shape nely+1 × nelx+1, where each element is a tuple defining the loading in x and y directions.

pub fn set_load(&mut self, idx: usize, jdx: usize, x: bool, y: bool) -> Self

Set a load at a specific node. The arguments define the indices of the node to be loaded, and the loads in the x and y directions.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Settings

fn default() -> Self

use topopt::Settings;
Settings::default();