waves
Basic FE playground
katoptron::Dirichlet Class Reference

Class used to specify in Python the different Dirichlet boundary conditions (both mechanical and thermal). More...

#include <wDirichlet.h>

Inheritance diagram for katoptron::Dirichlet:
Collaboration diagram for katoptron::Dirichlet:

Public Member Functions

 Dirichlet (Problem &pbl, std::string const &name, std::string const &_BC_name, std::vector< int > _which_dof, std::vector< double > _values, size_t ensemble_size=1)
 Dirichlet constructor. More...
 
 Dirichlet (Problem &pbl, std::string const &name, std::string const &_BC_name, int x, double v_x, int y, double v_y, int z, double v_z, int T=0, double v_T=0, size_t ensemble_size=1)
 Dirichlet constructor. More...
 
 Dirichlet (Problem &pbl, std::string const &name, std::string const &_BC_name, int x, std::vector< double > v_x, int y, std::vector< double > v_y, int z, std::vector< double > v_z, int T=0, std::vector< double > v_T={})
 Dirichlet constructor. More...
 
virtual void write (std::ostream &out) const
 Display information. More...
 

Public Attributes

const std::string & BC_name
 
std::vector< tbox::Node * > nodes
 
std::vector< int > which_dof
 
std::vector< double > values
 
std::vector< double > x_values
 
std::vector< double > y_values
 
std::vector< double > z_values
 
std::vector< double > T_values
 

Detailed Description

Class used to specify in Python the different Dirichlet boundary conditions (both mechanical and thermal).

Constructor & Destructor Documentation

◆ Dirichlet() [1/3]

Dirichlet::Dirichlet ( katoptron::Problem pbl,
std::string const &  name,
std::string const &  _BC_name,
std::vector< int >  _which_dof,
std::vector< double >  _values,
size_t  ensemble_size = 1 
)

Dirichlet constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the constrained surface of the msh,
  • _BC_name: the name of new Dirichlet BC (does not have to be a nametag of the msh),
  • _which_dof: a vector that specify which degree(s) of freedom are constrained,
  • _values: a vector that specify the values of the constrained degree(s) of freedom if they are constrained (the length of _which_dof and _values must be the same),
  • ensemble_size: the ensemble size.

◆ Dirichlet() [2/3]

Dirichlet::Dirichlet ( Problem pbl,
std::string const &  name,
std::string const &  _BC_name,
int  x,
double  v_x,
int  y,
double  v_y,
int  z,
double  v_z,
int  T = 0,
double  v_T = 0,
size_t  ensemble_size = 1 
)

Dirichlet constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the constrained surface of the msh,
  • _BC_name: the name of new Dirichlet BC (does not have to be a nametag of the msh),
  • x: a int which specify whether the x displacement component is constrained,
  • v_x: value of the constrained degree of freedom,
  • y: a int which specify whether the y displacement component is constrained,
  • v_y: value of the constrained degree of freedom,
  • z: a int which specify whether the z displacement component is constrained,
  • v_z: value of the constrained degree of freedom,
  • T: a int which specify whether the temperature is constrained,
  • v_T: value of the constrained degree of freedom,
  • ensemble_size: the ensemble size.

◆ Dirichlet() [3/3]

Dirichlet::Dirichlet ( Problem pbl,
std::string const &  name,
std::string const &  _BC_name,
int  x,
std::vector< double >  v_x,
int  y,
std::vector< double >  v_y,
int  z,
std::vector< double >  v_z,
int  T = 0,
std::vector< double >  v_T = {} 
)

Dirichlet constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the constrained surface of the msh,
  • _BC_name: the name of new Dirichlet BC (does not have to be a nametag of the msh),
  • x: a int which specify whether the x displacement component is constrained,
  • v_x: vector of values of the constrained degree of freedom (one per sample),
  • y: a int which specify whether the y displacement component is constrained,
  • v_y: vector of values of the constrained degree of freedom (one per sample),
  • z: a int which specify whether the z displacement component is constrained,
  • v_z: vector of values of the constrained degree of freedom (one per sample),
  • T: a int which specify whether the temperature is constrained,
  • v_T: vector of values of the constrained degree of freedom (one per sample).

Member Function Documentation

◆ write()

void Dirichlet::write ( std::ostream &  out) const
virtual

Display information.

Member Data Documentation

◆ BC_name

const std::string& katoptron::Dirichlet::BC_name

◆ nodes

std::vector<tbox::Node *> katoptron::Dirichlet::nodes

◆ T_values

std::vector<double> katoptron::Dirichlet::T_values

◆ values

std::vector<double> katoptron::Dirichlet::values

◆ which_dof

std::vector<int> katoptron::Dirichlet::which_dof

◆ x_values

std::vector<double> katoptron::Dirichlet::x_values

◆ y_values

std::vector<double> katoptron::Dirichlet::y_values

◆ z_values

std::vector<double> katoptron::Dirichlet::z_values

The documentation for this class was generated from the following files: