OpenCMISS-Iron Internal API Documentation
laplace_equations_routines Module Reference

This module handles all Laplace equations routines. More...

Functions/Subroutines

subroutine, public laplace_boundaryconditionsanalyticcalculate (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
 Calculates the analytic solution and sets the boundary conditions for an analytic problem. More...
 
subroutine, public laplaceequation_finiteelementcalculate (equationsSet, elementNumber, err, error,)
 Calculates the element stiffness matrices and RHS for a Laplace equation finite element equations set. More...
 
subroutine laplace_equationssetmovingmeshsetup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the moving mesh Laplace equation. More...
 
subroutine, public laplace_equation_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the Laplace equation type of a classical field equations set class. More...
 
subroutine, public laplace_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Sets/changes the solution method for a Laplace equation type of an classical field equations set class. More...
 
subroutine, public laplace_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the equation specification for a Laplace type of a classical field equations set. More...
 
subroutine laplace_equationssetstandardsetup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the standard Laplace equation. More...
 
subroutine laplace_equationssetgeneralisedsetup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the generalised Laplace equation. More...
 
subroutine, public laplace_equation_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the Laplace problem. More...
 
subroutine, public laplace_problemspecificationset (problem, problemSpecification, err, error,)
 Sets the problem specification for a Laplace equation type. More...
 
subroutine laplace_equation_problem_standard_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the standard Laplace equations problem. More...
 
subroutine laplace_equation_problem_generalised_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the generalised Laplace equations problem. More...
 

Detailed Description

This module handles all Laplace equations routines.

Function/Subroutine Documentation

subroutine, public laplace_equations_routines::laplace_boundaryconditionsanalyticcalculate ( type(equations_set_type), pointer  EQUATIONS_SET,
type(boundary_conditions_type), pointer  BOUNDARY_CONDITIONS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public laplace_equations_routines::laplace_equation_equations_set_setup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the Laplace equation type of a classical field equations set class.

Parameters
equations_setA pointer to the equations set to setup a Laplace equation on.
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 1400 of file Laplace_equations_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_generalised_laplace_subtype, equations_set_constants::equations_set_moving_mesh_laplace_subtype, equations_set_constants::equations_set_standard_laplace_subtype, base_routines::exits(), laplace_equationssetgeneralisedsetup(), laplace_equationssetmovingmeshsetup(), and laplace_equationssetstandardsetup().

Referenced by classical_field_routines::classical_field_equations_set_setup().

subroutine laplace_equations_routines::laplace_equation_problem_generalised_setup ( type(problem_type), pointer  PROBLEM,
type(problem_setup_type), intent(inout)  PROBLEM_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets up the generalised Laplace equations problem.

Parameters
problemA pointer to the problem to setup
[in,out]problem_setupThe problem setup information
[out]errThe error code
[out]errorThe error string

Definition at line 2677 of file Laplace_equations_routines.f90.

References control_loop_routines::control_loop_create_finish(), control_loop_routines::control_loop_create_start(), control_loop_routines::control_loop_node, control_loop_routines::control_loop_solvers_get(), base_routines::enters(), base_routines::exits(), problem_constants::problem_generalised_laplace_subtype, problem_constants::problem_setup_control_type, problem_constants::problem_setup_finish_action, problem_constants::problem_setup_initial_type, problem_constants::problem_setup_solver_equations_type, problem_constants::problem_setup_solvers_type, problem_constants::problem_setup_start_action, solver_routines::solver_equations_create_finish(), solver_routines::solver_equations_create_start(), problem_constants::solver_equations_linear, solver_routines::solver_equations_linearity_type_set(), solver_routines::solver_equations_sparsity_type_set(), problem_constants::solver_equations_static, solver_routines::solver_equations_time_dependence_type_set(), solver_routines::solver_library_type_set(), solver_routines::solver_linear_type, solver_routines::solver_petsc_library, solver_routines::solver_solver_equations_get(), solver_routines::solver_sparse_matrices, solver_routines::solver_type_set(), solver_routines::solvers_create_finish(), solver_routines::solvers_create_start(), solver_routines::solvers_number_set(), and solver_routines::solvers_solver_get().

Referenced by laplace_equation_problem_setup().

subroutine, public laplace_equations_routines::laplace_equation_problem_setup ( type(problem_type), pointer  PROBLEM,
type(problem_setup_type), intent(inout)  PROBLEM_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the Laplace problem.

Parameters
problemA pointer to the problem set to setup a Laplace equation on.
[in,out]problem_setupThe problem setup information
[out]errThe error code
[out]errorThe error string

Definition at line 2446 of file Laplace_equations_routines.f90.

References base_routines::enters(), base_routines::exits(), laplace_equation_problem_generalised_setup(), laplace_equation_problem_standard_setup(), problem_constants::problem_generalised_laplace_subtype, and problem_constants::problem_standard_laplace_subtype.

Referenced by classical_field_routines::classical_field_problem_setup().

subroutine laplace_equations_routines::laplace_equation_problem_standard_setup ( type(problem_type), pointer  PROBLEM,
type(problem_setup_type), intent(inout)  PROBLEM_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets up the standard Laplace equations problem.

Parameters
problemA pointer to the problem to setup
[in,out]problem_setupThe problem setup information
[out]errThe error code
[out]errorThe error string

Definition at line 2541 of file Laplace_equations_routines.f90.

References control_loop_routines::control_loop_create_finish(), control_loop_routines::control_loop_create_start(), control_loop_routines::control_loop_node, control_loop_routines::control_loop_solvers_get(), base_routines::enters(), base_routines::exits(), problem_constants::problem_setup_control_type, problem_constants::problem_setup_finish_action, problem_constants::problem_setup_initial_type, problem_constants::problem_setup_solver_equations_type, problem_constants::problem_setup_solvers_type, problem_constants::problem_setup_start_action, problem_constants::problem_standard_laplace_subtype, solver_routines::solver_equations_create_finish(), solver_routines::solver_equations_create_start(), problem_constants::solver_equations_linear, solver_routines::solver_equations_linearity_type_set(), solver_routines::solver_equations_sparsity_type_set(), problem_constants::solver_equations_static, solver_routines::solver_equations_time_dependence_type_set(), solver_routines::solver_library_type_set(), solver_routines::solver_linear_type, solver_routines::solver_petsc_library, solver_routines::solver_solver_equations_get(), solver_routines::solver_sparse_matrices, solver_routines::solver_type_set(), solver_routines::solvers_create_finish(), solver_routines::solvers_create_start(), solver_routines::solvers_number_set(), and solver_routines::solvers_solver_get().

Referenced by laplace_equation_problem_setup().

subroutine laplace_equations_routines::laplace_equationssetgeneralisedsetup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets up the generalised Laplace equation.

Parameters
equations_setA pointer to the equations set to setup
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 1959 of file Laplace_equations_routines.f90.

References base_routines::enters(), equations_routines::equations_create_finish(), equations_routines::equations_create_start(), equations_set_constants::equations_linear, equations_routines::equations_linearity_type_set(), equations_mapping_routines::equations_mapping_create_finish(), equations_mapping_routines::equations_mapping_create_start(), equations_mapping_routines::equations_mapping_rhs_variable_type_set(), equations_matrices_routines::equations_matrices_create_finish(), equations_matrices_routines::equations_matrices_create_start(), equations_matrices_routines::equations_matrices_full_matrices, equations_matrices_routines::equations_matrices_linear_storage_type_set(), equations_matrices_routines::equations_matrices_sparse_matrices, equations_matrices_routines::equations_matrix_fem_structure, equations_set_constants::equations_set_bem_solution_method, equations_routines::equations_set_equations_get(), equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fem_solution_method, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_generalised_laplace_subtype, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, equations_set_constants::equations_set_laplace_equation_three_dim_1, equations_set_constants::equations_set_laplace_equation_three_dim_2, equations_set_constants::equations_set_laplace_equation_two_dim_1, equations_set_constants::equations_set_laplace_equation_two_dim_2, equations_set_constants::equations_set_setup_analytic_type, equations_set_constants::equations_set_setup_dependent_type, equations_set_constants::equations_set_setup_equations_type, equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_initial_type, equations_set_constants::equations_set_setup_materials_type, equations_set_constants::equations_set_setup_source_type, equations_set_constants::equations_set_setup_start_action, equations_set_constants::equations_static, equations_routines::equations_time_dependence_type_set(), equations_mapping_routines::equationsmapping_linearmatricesnumberset(), equations_mapping_routines::equationsmapping_linearmatricesvariabletypesset(), equations_matrices_routines::equationsmatrices_linearstructuretypeset(), base_routines::errors(), base_routines::exits(), laplace_equationssetsolutionmethodset(), matrix_vector::matrix_block_storage_type, and matrix_vector::matrix_compressed_row_storage_type.

Referenced by laplace_equation_equations_set_setup().

subroutine laplace_equations_routines::laplace_equationssetmovingmeshsetup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets up the moving mesh Laplace equation.

Parameters
equations_setA pointer to the equations set to setup
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 867 of file Laplace_equations_routines.f90.

References base_routines::enters(), equations_routines::equations_create_finish(), equations_routines::equations_create_start(), equations_set_constants::equations_linear, equations_routines::equations_linearity_type_set(), equations_mapping_routines::equations_mapping_create_finish(), equations_mapping_routines::equations_mapping_create_start(), equations_mapping_routines::equations_mapping_rhs_variable_type_set(), equations_matrices_routines::equations_matrices_create_finish(), equations_matrices_routines::equations_matrices_create_start(), equations_matrices_routines::equations_matrices_full_matrices, equations_matrices_routines::equations_matrices_linear_storage_type_set(), equations_matrices_routines::equations_matrices_sparse_matrices, equations_matrices_routines::equations_matrix_fem_structure, equations_set_constants::equations_set_bem_solution_method, equations_routines::equations_set_equations_get(), equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fem_solution_method, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, equations_set_constants::equations_set_laplace_equation_three_dim_1, equations_set_constants::equations_set_laplace_equation_three_dim_2, equations_set_constants::equations_set_laplace_equation_two_dim_1, equations_set_constants::equations_set_laplace_equation_two_dim_2, equations_set_constants::equations_set_moving_mesh_laplace_subtype, equations_set_constants::equations_set_setup_analytic_type, equations_set_constants::equations_set_setup_dependent_type, equations_set_constants::equations_set_setup_equations_type, equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_independent_type, equations_set_constants::equations_set_setup_initial_type, equations_set_constants::equations_set_setup_materials_type, equations_set_constants::equations_set_setup_source_type, equations_set_constants::equations_set_setup_start_action, equations_set_constants::equations_static, equations_routines::equations_time_dependence_type_set(), equations_mapping_routines::equationsmapping_linearmatricesnumberset(), equations_mapping_routines::equationsmapping_linearmatricesvariabletypesset(), equations_matrices_routines::equationsmatrices_linearstructuretypeset(), base_routines::exits(), laplace_equationssetsolutionmethodset(), matrix_vector::matrix_block_storage_type, and matrix_vector::matrix_compressed_row_storage_type.

Referenced by laplace_equation_equations_set_setup().

subroutine, public laplace_equations_routines::laplace_equationssetsolutionmethodset ( type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(in)  SOLUTION_METHOD,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public laplace_equations_routines::laplace_equationssetspecificationset ( type(equations_set_type), pointer  equationsSet,
integer(intg), dimension(:), intent(in)  specification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets the equation specification for a Laplace type of a classical field equations set.

Parameters
equationssetA pointer to the equations set to set the specification for
[in]specificationThe equations set specification to set
[out]errThe error code
[out]errorThe error string

Definition at line 1541 of file Laplace_equations_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_generalised_laplace_subtype, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_moving_mesh_laplace_subtype, equations_set_constants::equations_set_standard_laplace_subtype, base_routines::errors(), and base_routines::exits().

Referenced by classical_field_routines::classicalfield_equationssetspecificationset().

subroutine laplace_equations_routines::laplace_equationssetstandardsetup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets up the standard Laplace equation.

Parameters
equations_setA pointer to the equations set to setup
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 1595 of file Laplace_equations_routines.f90.

References base_routines::enters(), equations_routines::equations_create_finish(), equations_routines::equations_create_start(), equations_set_constants::equations_linear, equations_routines::equations_linearity_type_set(), equations_mapping_routines::equations_mapping_create_finish(), equations_mapping_routines::equations_mapping_create_start(), equations_mapping_routines::equations_mapping_rhs_variable_type_set(), equations_matrices_routines::equations_matrices_create_finish(), equations_matrices_routines::equations_matrices_create_start(), equations_matrices_routines::equations_matrices_full_matrices, equations_matrices_routines::equations_matrices_linear_storage_type_set(), equations_matrices_routines::equations_matrices_sparse_matrices, equations_matrices_routines::equations_matrix_fem_structure, equations_set_constants::equations_set_bem_solution_method, equations_routines::equations_set_equations_get(), equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fem_solution_method, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, equations_set_constants::equations_set_laplace_equation_three_dim_1, equations_set_constants::equations_set_laplace_equation_three_dim_2, equations_set_constants::equations_set_laplace_equation_two_dim_1, equations_set_constants::equations_set_laplace_equation_two_dim_2, equations_set_constants::equations_set_setup_analytic_type, equations_set_constants::equations_set_setup_dependent_type, equations_set_constants::equations_set_setup_equations_type, equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_initial_type, equations_set_constants::equations_set_setup_materials_type, equations_set_constants::equations_set_setup_source_type, equations_set_constants::equations_set_setup_start_action, equations_set_constants::equations_set_standard_laplace_subtype, equations_set_constants::equations_static, equations_routines::equations_time_dependence_type_set(), equations_mapping_routines::equationsmapping_linearmatricesnumberset(), equations_mapping_routines::equationsmapping_linearmatricesvariabletypesset(), equations_matrices_routines::equationsmatrices_linearstructuretypeset(), base_routines::exits(), laplace_equationssetsolutionmethodset(), matrix_vector::matrix_block_storage_type, and matrix_vector::matrix_compressed_row_storage_type.

Referenced by laplace_equation_equations_set_setup().

subroutine, public laplace_equations_routines::laplace_problemspecificationset ( type(problem_type), pointer  problem,
integer(intg), dimension(:), intent(in)  problemSpecification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets the problem specification for a Laplace equation type.

Parameters
problemA pointer to the problem to set the problem specification for
[in]problemspecificationThe problem specification to set
[out]errThe error code
[out]errorThe error string

Definition at line 2489 of file Laplace_equations_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), problem_constants::problem_classical_field_class, problem_constants::problem_generalised_laplace_subtype, problem_constants::problem_laplace_equation_type, and problem_constants::problem_standard_laplace_subtype.

Referenced by classical_field_routines::classicalfield_problemspecificationset().

subroutine, public laplace_equations_routines::laplaceequation_finiteelementcalculate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  elementNumber,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Calculates the element stiffness matrices and RHS for a Laplace equation finite element equations set.

Parameters
equationssetA pointer to the equations set to perform the finite element calculations on
[in]elementnumberThe element number to calculate
[out]errThe error code
[out]errorThe error string

Definition at line 429 of file Laplace_equations_routines.f90.

References basis_routines::basis_default_quadrature_scheme, coordinate_routines::coordinates_materialsystemcalculate(), base_routines::enters(), equations_set_constants::equations_set_generalised_laplace_subtype, equations_set_constants::equations_set_moving_mesh_laplace_subtype, equations_set_constants::equations_set_standard_laplace_subtype, base_routines::exits(), constants::first_part_deriv, constants::no_part_deriv, and constants::partial_derivative_first_derivative_map.

Referenced by classical_field_routines::classical_field_finite_element_calculate().