waves
Basic FE playground
katoptron::Weight Class Reference

Class used to specify in Python the different weights used for the computation of the weighted residual of the GMRES. More...

#include <wWeight.h>

Inheritance diagram for katoptron::Weight:
Collaboration diagram for katoptron::Weight:

Public Member Functions

 Weight (Problem &pbl, std::string const &name, std::vector< int > _which_dof, std::vector< double > _values, size_t ensemble_size=1)
 Weight constructor. More...
 
 Weight (Problem &pbl, std::string const &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)
 Weight constructor. More...
 
 Weight (Problem &pbl, std::string const &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={})
 Weight constructor. More...
 
virtual void write (std::ostream &out) const
 Display information. More...
 

Public Attributes

std::vector< 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 weights used for the computation of the weighted residual of the GMRES.

Constructor & Destructor Documentation

◆ Weight() [1/3]

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

Weight constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the weighted domain of the msh,
  • _which_dof: a vector that specify which degree(s) of freedom are weighted,
  • _values: a vector that specify the values of the weights (the length of _which_dof and _values must be the same),
  • ensemble_size: the ensemble size.

◆ Weight() [2/3]

Weight::Weight ( Problem pbl,
std::string const &  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 
)

Weight constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the weighted domain of the msh,
  • x: a int which specify whether the x displacement component is weighted,
  • v_x: value of the weight,
  • y: a int which specify whether the y displacement component is weighted,
  • v_y: value of the weight,
  • z: a int which specify whether the z displacement component is weighted,
  • v_z: value of the weight,
  • T: a int which specify whether the temperature is constrained,
  • v_T: value of the weight,
  • ensemble_size: the ensemble size.

◆ Weight() [3/3]

Weight::Weight ( Problem pbl,
std::string const &  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 = {} 
)

Weight constructor.

Arguments:

  • pbl: a Problem object,
  • name: the name of the weighted domain of the msh,
  • x: a int which specify whether the x displacement component is weighted,
  • v_x: vector of values of the weight (one per sample),
  • y: a int which specify whether the y displacement component is weighted,
  • v_y: vector of values of the weight (one per sample),
  • z: a int which specify whether the z displacement component is weighted,
  • v_z: vector of values of the weight (one per sample),
  • T: a int which specify whether the temperature is constrained,
  • v_T: vector of values of the weight (one per sample),
  • ensemble_size: the ensemble size.

Member Function Documentation

◆ write()

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

Display information.

Member Data Documentation

◆ nodes

std::vector<Node *> katoptron::Weight::nodes

◆ T_values

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

◆ values

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

◆ which_dof

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

◆ x_values

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

◆ y_values

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

◆ z_values

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

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