Detailed Description

Definition at line 40 of file transient_solver_base.h.

#include <transient_solver_base.h>

Inheritance diagram for MAST::TransientSolverBase:

[legend]

Collaboration diagram for MAST::TransientSolverBase:

[legend]

Public Member Functions
	TransientSolverBase (unsigned int o, unsigned int n)
	constructor requires the number of iterations to store for the derived solver. More...

virtual	~TransientSolverBase ()

libMesh::NumericVector< Real > &	acceleration (unsigned int prev_iter=0) const

libMesh::NumericVector< Real > &	acceleration_sensitivity (unsigned int prev_iter=0) const

virtual void	advance_time_step (bool increment_time=true)
	advances the time step and copies the current solution to old solution, and so on. More...

virtual void	advance_time_step_with_sensitivity ()
	advances the time step and copies the current sensitivity solution to old sensitivity solution, and so on. More...

virtual void	build_local_quantities (const libMesh::NumericVector< Real > &current_sol, std::vector< libMesh::NumericVector< Real > *> &qtys)
	localizes the relevant solutions for system assembly. More...

virtual void	build_sensitivity_local_quantities (unsigned int prev_iter, std::vector< libMesh::NumericVector< Real > *> &qtys)
	localizes the relevant solutions for system assembly. More...

virtual void	clear_assembly ()
	clears the assembly object More...

virtual void	clear_elem_operation_object ()
	Clears the assembly elem operations object. More...

virtual MAST::TransientAssemblyElemOperations &	get_elem_operation_object ()

virtual void	sensitivity_solve (MAST::AssemblyBase &assembly, const MAST::FunctionBase &f)
	solvers the current time step for sensitivity wrt `f` More...

virtual void	set_assembly (MAST::AssemblyBase &assembly)
	sets the assembly object More...

virtual void	set_elem_operation_object (MAST::TransientAssemblyElemOperations &elem_ops)
	Attaches the assembly elem operations object that provides the x_dot, M and J quantities for the element. More...

libMesh::NumericVector< Real > &	solution (unsigned int prev_iter=0) const

libMesh::NumericVector< Real > &	solution_sensitivity (unsigned int prev_iter=0) const

virtual void	solve (MAST::AssemblyBase &assembly)
	solves the current time step for solution and velocity More...

void	solve_highest_derivative_and_advance_time_step (MAST::AssemblyBase &assembly, bool increment_time=true)
	To be used only for initial conditions. More...

void	solve_highest_derivative_and_advance_time_step_with_sensitivity (MAST::AssemblyBase &assembly, const MAST::FunctionBase &f)
	solves for the sensitivity of highest derivative and advances the time-step. More...

virtual void	update_acceleration (libMesh::NumericVector< Real > &acc, const libMesh::NumericVector< Real > &sol)=0
	update the transient acceleration based on the current solution More...

virtual void	update_delta_acceleration (libMesh::NumericVector< Real > &acc, const libMesh::NumericVector< Real > &sol)=0
	update the perturbation in transient acceleration based on the current perturbed solution More...

virtual void	update_delta_velocity (libMesh::NumericVector< Real > &vel, const libMesh::NumericVector< Real > &sol)=0
	update the perturbation in transient velocity based on the current perturbed solution More...

virtual void	update_sensitivity_acceleration (libMesh::NumericVector< Real > &acc, const libMesh::NumericVector< Real > &sol)=0
	update the transient sensitivity acceleration based on the current sensitivity solution More...

virtual void	update_sensitivity_velocity (libMesh::NumericVector< Real > &vel, const libMesh::NumericVector< Real > &sol)=0
	update the transient sensitivity velocity based on the current sensitivity solution More...

virtual void	update_velocity (libMesh::NumericVector< Real > &vel, const libMesh::NumericVector< Real > &sol)=0
	update the transient velocity based on the current solution More...

libMesh::NumericVector< Real > &	velocity (unsigned int prev_iter=0) const

libMesh::NumericVector< Real > &	velocity_sensitivity (unsigned int prev_iter=0) const

Public Member Functions inherited from MAST::NonlinearImplicitAssemblyElemOperations
	NonlinearImplicitAssemblyElemOperations ()

virtual	~NonlinearImplicitAssemblyElemOperations ()

void	check_element_numerical_jacobian (RealVectorX &sol)
	a helper function to evaluate the numerical Jacobian and compare it with the analytical Jacobian. More...

virtual void	elem_calculations (bool if_jac, RealVectorX &vec, RealMatrixX &mat)=0
	performs the element calculations over `elem`, and returns the element vector and matrix quantities in `mat` and `vec`, respectively. More...

virtual void	elem_linearized_jacobian_solution_product (RealVectorX &vec)=0
	performs the element calculations over `elem`, and returns the element vector quantity in `vec`. More...

virtual void	elem_second_derivative_dot_solution_assembly (RealMatrixX &mat)=0
	calculates $d ([J] \{\Delta X\})/ dX$ over `elem`, and returns the matrix in `vec` . More...

virtual void	elem_sensitivity_calculations (const MAST::FunctionBase &f, RealVectorX &vec)=0
	performs the element sensitivity calculations over `elem`, and returns the element residual sensitivity in `vec` . More...

virtual void	elem_shape_sensitivity_calculations (const MAST::FunctionBase &f, RealVectorX &vec)=0
	performs the element shape sensitivity calculations over `elem`, and returns the element residual sensitivity in `vec` . More...

virtual void	elem_topology_sensitivity_calculations (const MAST::FunctionBase &f, RealVectorX &vec)=0
	performs the element topology sensitivity calculations over `elem`, and returns the element residual sensitivity in `vec` . More...

virtual void	elem_topology_sensitivity_calculations (const MAST::FunctionBase &f, const MAST::FieldFunction< RealVectorX > &vel, RealVectorX &vec)=0
	performs the element topology sensitivity calculations over `elem`, and returns the element residual sensitivity in `vec` . More...

Public Member Functions inherited from MAST::AssemblyElemOperations
	AssemblyElemOperations ()

virtual	~AssemblyElemOperations ()

virtual void	clear_discipline_and_system ()
	clears association with a system to this discipline More...

virtual void	clear_elem ()
	clears the element initialization More...

virtual MAST::AssemblyBase &	get_assembly ()

MAST::PhysicsDisciplineBase &	get_discipline ()

virtual std::pair< const MAST::FieldFunction< RealVectorX > *, unsigned int >	get_elem_boundary_velocity_data ()
	searches through the side load data and populates the data with the boundary id and velocity function on the boundary. More...

MAST::ElementBase &	get_physics_elem ()

MAST::SystemInitialization &	get_system_initialization ()

virtual void	init (const MAST::GeomElem &elem)=0
	initializes the object for calculation of element quantities for the specified `elem`. More...

virtual void	set_discipline_and_system (MAST::PhysicsDisciplineBase &discipline, MAST::SystemInitialization &system)
	attaches a system to this discipline More...

virtual void	set_elem_acceleration (const RealVectorX &accel)
	sets the element acceleration More...

virtual void	set_elem_acceleration_sensitivity (const RealVectorX &accel)
	sets the element acceleration More...

virtual void	set_elem_data (unsigned int dim, const libMesh::Elem &ref_elem, MAST::GeomElem &elem) const =0
	some analyses may want to set additional element data before initialization of the GeomElem. More...

virtual void	set_elem_perturbed_acceleration (const RealVectorX &accel)
	sets the element perturbed acceleration More...

virtual void	set_elem_perturbed_solution (const RealVectorX &sol)
	sets the element perturbed solution More...

virtual void	set_elem_perturbed_velocity (const RealVectorX &vel)
	sets the element perturbed velocity More...

virtual void	set_elem_solution (const RealVectorX &sol)
	sets the element solution More...

virtual void	set_elem_solution_sensitivity (const RealVectorX &sol)
	sets the element solution sensitivity More...

virtual void	set_elem_velocity (const RealVectorX &vel)
	sets the element velocity More...

virtual void	set_elem_velocity_sensitivity (const RealVectorX &vel)
	sets the element velocity sensitivity More...

void	set_skip_comm_sum (bool skip)
	If an output has contrinutions only from local processor then the user can request that the global comm().sum() calls be skipped to avoid blocking MPI calls. More...

Public Attributes
Real	dt
	time step More...

Additional Inherited Members
Protected Attributes inherited from MAST::AssemblyElemOperations
MAST::AssemblyBase *	_assembly

MAST::PhysicsDisciplineBase *	_discipline

MAST::ElementBase *	_physics_elem

bool	_skip_comm_sum
	If an output has contrinutions only from local processor then the user can request that the global comm().sum() calls be skipped to avoid blocking MPI calls. More...

MAST::SystemInitialization *	_system

Constructor & Destructor Documentation

◆ TransientSolverBase()

MAST::TransientSolverBase::TransientSolverBase	(	unsigned int	o,
		unsigned int	n
	)

constructor requires the number of iterations to store for the derived solver.

Definition at line 36 of file transient_solver_base.cpp.

◆ ~TransientSolverBase()

MAST::TransientSolverBase::~TransientSolverBase ( )

virtual

Definition at line 52 of file transient_solver_base.cpp.

Member Function Documentation

◆ acceleration()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::acceleration ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized acceleration from iteration number = current - prev_iter. So, prev_iter = 0 gives the current acceleration estimate. Note that prev_iter cannot be greater than the total number of iterations that this solver stores solutions for.

Definition at line 278 of file transient_solver_base.cpp.

◆ acceleration_sensitivity()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::acceleration_sensitivity ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized acceleration sensitivity. The prev_iter parameter is similar to the acceleration() method.

Definition at line 297 of file transient_solver_base.cpp.

◆ advance_time_step()

void MAST::TransientSolverBase::advance_time_step ( bool increment_time = true )

virtual

advances the time step and copies the current solution to old solution, and so on.

If increment_time is true then the value fo time will be incremented in System. This may be useful when calling this method inside a sensitivity analysis routine.

Definition at line 738 of file transient_solver_base.cpp.

◆ advance_time_step_with_sensitivity()

void MAST::TransientSolverBase::advance_time_step_with_sensitivity ( )

virtual

advances the time step and copies the current sensitivity solution to old sensitivity solution, and so on.

Does not influence the primary solution.

Definition at line 771 of file transient_solver_base.cpp.

◆ build_local_quantities()

void MAST::TransientSolverBase::build_local_quantities	(	const libMesh::NumericVector< Real > &	current_sol,
		std::vector< libMesh::NumericVector< Real > *> &	qtys
	)

virtual

localizes the relevant solutions for system assembly.

The calling function has to delete the pointers to these vectors

Definition at line 516 of file transient_solver_base.cpp.

◆ build_sensitivity_local_quantities()

void MAST::TransientSolverBase::build_sensitivity_local_quantities	(	unsigned int	prev_iter,
		std::vector< libMesh::NumericVector< Real > *> &	qtys
	)

virtual

localizes the relevant solutions for system assembly.

The calling function has to delete the pointers to these vectors. prev_iter = 0 implies the current iterate, while increasing values will identify decreasing iterations for which data is stored.

Definition at line 598 of file transient_solver_base.cpp.

◆ clear_assembly()

void MAST::TransientSolverBase::clear_assembly ( )

virtual

clears the assembly object

Reimplemented from MAST::AssemblyElemOperations.

Definition at line 69 of file transient_solver_base.cpp.

◆ clear_elem_operation_object()

void MAST::TransientSolverBase::clear_elem_operation_object ( )

virtual

Clears the assembly elem operations object.

Definition at line 145 of file transient_solver_base.cpp.

◆ get_elem_operation_object()

MAST::TransientAssemblyElemOperations & MAST::TransientSolverBase::get_elem_operation_object ( )

virtual

Definition at line 78 of file transient_solver_base.cpp.

◆ sensitivity_solve()

void MAST::TransientSolverBase::sensitivity_solve	(	MAST::AssemblyBase &	assembly,
		const MAST::FunctionBase &	f
	)

virtual

solvers the current time step for sensitivity wrt f

Reimplemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver.

Definition at line 329 of file transient_solver_base.cpp.

◆ set_assembly()

void MAST::TransientSolverBase::set_assembly ( MAST::AssemblyBase & assembly )

virtual

sets the assembly object

Reimplemented from MAST::AssemblyElemOperations.

Definition at line 60 of file transient_solver_base.cpp.

◆ set_elem_operation_object()

void MAST::TransientSolverBase::set_elem_operation_object ( MAST::TransientAssemblyElemOperations & elem_ops )

virtual

Attaches the assembly elem operations object that provides the x_dot, M and J quantities for the element.

Definition at line 88 of file transient_solver_base.cpp.

◆ solution()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::solution ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized solution from iteration number = current - prev_iter. So, prev_iter = 0 gives the current solution estimate. Note that prev_iter cannot be greater than the total number of iterations that this solver stores solutions for.

Definition at line 197 of file transient_solver_base.cpp.

◆ solution_sensitivity()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::solution_sensitivity ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized solution sensitivity. The prev_iter parameter is similar to the solution() method.

Definition at line 220 of file transient_solver_base.cpp.

◆ solve()

void MAST::TransientSolverBase::solve ( MAST::AssemblyBase & assembly )

virtual

solves the current time step for solution and velocity

Definition at line 316 of file transient_solver_base.cpp.

◆ solve_highest_derivative_and_advance_time_step()

void MAST::TransientSolverBase::solve_highest_derivative_and_advance_time_step	(	MAST::AssemblyBase &	assembly,
		bool	increment_time = `true`
	)

To be used only for initial conditions.

Initializes the highest derivative solution using the solution and its low order time derivatives at the specified time step. Then advances the time step so that the solver is ready for time integration. If increment_time is true then the value fo time will be incremented in System. This may be useful when calling this method inside a sensitivity analysis routine.

Definition at line 345 of file transient_solver_base.cpp.

◆ solve_highest_derivative_and_advance_time_step_with_sensitivity()

void MAST::TransientSolverBase::solve_highest_derivative_and_advance_time_step_with_sensitivity	(	MAST::AssemblyBase &	assembly,
		const MAST::FunctionBase &	f
	)

solves for the sensitivity of highest derivative and advances the time-step.

Definition at line 431 of file transient_solver_base.cpp.

◆ update_acceleration()

virtual void MAST::TransientSolverBase::update_acceleration	(	libMesh::NumericVector< Real > &	acc,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the transient acceleration based on the current solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ update_delta_acceleration()

virtual void MAST::TransientSolverBase::update_delta_acceleration	(	libMesh::NumericVector< Real > &	acc,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the perturbation in transient acceleration based on the current perturbed solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ update_delta_velocity()

virtual void MAST::TransientSolverBase::update_delta_velocity	(	libMesh::NumericVector< Real > &	vel,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the perturbation in transient velocity based on the current perturbed solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ update_sensitivity_acceleration()

virtual void MAST::TransientSolverBase::update_sensitivity_acceleration	(	libMesh::NumericVector< Real > &	acc,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the transient sensitivity acceleration based on the current sensitivity solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ update_sensitivity_velocity()

virtual void MAST::TransientSolverBase::update_sensitivity_velocity	(	libMesh::NumericVector< Real > &	vel,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the transient sensitivity velocity based on the current sensitivity solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ update_velocity()

virtual void MAST::TransientSolverBase::update_velocity	(	libMesh::NumericVector< Real > &	vel,
		const libMesh::NumericVector< Real > &	sol
	)

pure virtual

update the transient velocity based on the current solution

Implemented in MAST::StabilizedFirstOrderNewmarkTransientSensitivitySolver, and MAST::SecondOrderNewmarkTransientSolver.

◆ velocity()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::velocity ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized velocity from iteration number = current - prev_iter. So, prev_iter = 0 gives the current velocity estimate. Note that prev_iter cannot be greater than the total number of iterations that this solver stores solutions for.

Definition at line 239 of file transient_solver_base.cpp.

◆ velocity_sensitivity()

libMesh::NumericVector< Real > & MAST::TransientSolverBase::velocity_sensitivity ( unsigned int prev_iter = 0 ) const

Returns: a reference to the localized velocity sensitivity. The prev_iter parameter is similar to the velocity() method.

Definition at line 258 of file transient_solver_base.cpp.

Member Data Documentation

◆ dt

Real MAST::TransientSolverBase::dt

time step

Definition at line 77 of file transient_solver_base.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/solver/transient_solver_base.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/solver/transient_solver_base.cpp

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TransientSolverBase()

◆ ~TransientSolverBase()

Member Function Documentation

◆ acceleration()

◆ acceleration_sensitivity()

◆ advance_time_step()

◆ advance_time_step_with_sensitivity()

◆ build_local_quantities()

◆ build_sensitivity_local_quantities()

◆ clear_assembly()

◆ clear_elem_operation_object()

◆ get_elem_operation_object()

◆ sensitivity_solve()

◆ set_assembly()

◆ set_elem_operation_object()

◆ solution()

◆ solution_sensitivity()

◆ solve()

◆ solve_highest_derivative_and_advance_time_step()

◆ solve_highest_derivative_and_advance_time_step_with_sensitivity()

◆ update_acceleration()

◆ update_delta_acceleration()

◆ update_delta_velocity()

◆ update_sensitivity_acceleration()

◆ update_sensitivity_velocity()

◆ update_velocity()

◆ velocity()

◆ velocity_sensitivity()

Member Data Documentation

◆ dt