libMesh
Public Member Functions | Private Attributes | List of all members
libMesh::RBTemporalDiscretization Class Reference

Define a class that encapsulates the details of a "generalized Euler" temporal discretization to be used in the rbOOmit framework. More...

#include <rb_temporal_discretization.h>

Inheritance diagram for libMesh::RBTemporalDiscretization:
[legend]

Public Member Functions

 RBTemporalDiscretization ()
 Constructor. More...
 
Real get_delta_t () const
 Get/set delta_t, the time-step size. More...
 
void set_delta_t (const Real delta_t_in)
 
Real get_euler_theta () const
 Get/set euler_theta, parameter that determines the temporal discretization. More...
 
void set_euler_theta (const Real euler_theta_in)
 
unsigned int get_time_step () const
 Get/set the current time-step. More...
 
void set_time_step (const unsigned int k)
 
unsigned int get_n_time_steps () const
 Get/set the total number of time-steps. More...
 
void set_n_time_steps (const unsigned int K)
 
Real get_control (const unsigned int k) const
 Get/set the RHS control. More...
 
void set_control (const std::vector< Real > &control)
 
void process_temporal_parameters_file (const std::string &parameters_filename)
 Read in and initialize parameters from parameters_filename. More...
 
void pull_temporal_discretization_data (RBTemporalDiscretization &other)
 Pull the temporal discretization data from other. More...
 

Private Attributes

Real _delta_t
 The time-step size. More...
 
Real _euler_theta
 The parameter that determines the generalized Euler scheme discretization that we employ. More...
 
unsigned int _current_time_step
 The current time-step. More...
 
unsigned int _n_time_steps
 The number of time-steps. More...
 
std::vector< Real_control
 The RHS control (scalar function of time). More...
 

Detailed Description

Define a class that encapsulates the details of a "generalized Euler" temporal discretization to be used in the rbOOmit framework.

Author
David Knezevic
Date
2012 Encapsulates the details of the generalized Euler discretization.

Definition at line 40 of file rb_temporal_discretization.h.

Constructor & Destructor Documentation

◆ RBTemporalDiscretization()

libMesh::RBTemporalDiscretization::RBTemporalDiscretization ( )

Constructor.

Member Function Documentation

◆ get_control()

Real libMesh::RBTemporalDiscretization::get_control ( const unsigned int  k) const

Get/set the RHS control.

◆ get_delta_t()

Real libMesh::RBTemporalDiscretization::get_delta_t ( ) const

Get/set delta_t, the time-step size.

◆ get_euler_theta()

Real libMesh::RBTemporalDiscretization::get_euler_theta ( ) const

Get/set euler_theta, parameter that determines the temporal discretization.

◆ get_n_time_steps()

unsigned int libMesh::RBTemporalDiscretization::get_n_time_steps ( ) const

Get/set the total number of time-steps.

◆ get_time_step()

unsigned int libMesh::RBTemporalDiscretization::get_time_step ( ) const

Get/set the current time-step.

◆ process_temporal_parameters_file()

void libMesh::RBTemporalDiscretization::process_temporal_parameters_file ( const std::string &  parameters_filename)

Read in and initialize parameters from parameters_filename.

◆ pull_temporal_discretization_data()

void libMesh::RBTemporalDiscretization::pull_temporal_discretization_data ( RBTemporalDiscretization other)

Pull the temporal discretization data from other.

◆ set_control()

void libMesh::RBTemporalDiscretization::set_control ( const std::vector< Real > &  control)

◆ set_delta_t()

void libMesh::RBTemporalDiscretization::set_delta_t ( const Real  delta_t_in)

◆ set_euler_theta()

void libMesh::RBTemporalDiscretization::set_euler_theta ( const Real  euler_theta_in)

◆ set_n_time_steps()

void libMesh::RBTemporalDiscretization::set_n_time_steps ( const unsigned int  K)

◆ set_time_step()

void libMesh::RBTemporalDiscretization::set_time_step ( const unsigned int  k)

Member Data Documentation

◆ _control

std::vector<Real> libMesh::RBTemporalDiscretization::_control
private

The RHS control (scalar function of time).

A function h(t) that is used in the RHS as h(t)*f(x, $ \mu $). See Martin Grepl's thesis

Definition at line 121 of file rb_temporal_discretization.h.

◆ _current_time_step

unsigned int libMesh::RBTemporalDiscretization::_current_time_step
private

The current time-step.

Definition at line 109 of file rb_temporal_discretization.h.

◆ _delta_t

Real libMesh::RBTemporalDiscretization::_delta_t
private

The time-step size.

Definition at line 95 of file rb_temporal_discretization.h.

◆ _euler_theta

Real libMesh::RBTemporalDiscretization::_euler_theta
private

The parameter that determines the generalized Euler scheme discretization that we employ.

euler_theta = 0 —> Forward Euler euler_theta = 0.5 —> Crank-Nicolson euler_theta = 1 —> Backward Euler

Definition at line 104 of file rb_temporal_discretization.h.

◆ _n_time_steps

unsigned int libMesh::RBTemporalDiscretization::_n_time_steps
private

The number of time-steps.

Definition at line 114 of file rb_temporal_discretization.h.


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