- Generated on Mon Apr 9 2018 20:02:31 for OpenCMISS-Iron Internal API Documentation by
1.8.11
|
OpenCMISS-Iron Internal API Documentation
|
This module handles all classical field class routines. More...
Functions/Subroutines | |
| subroutine, public | classical_field_analytic_functions_evaluate (EQUATIONS_SET, EQUATIONS_TYPE, ANALYTIC_FUNCTION_TYPE, POSITION, TANGENTS, NORMAL, TIME, VARIABLE_TYPE, GLOBAL_DERIVATIVE, COMPONENT_NUMBER, ANALYTIC_PARAMETERS, MATERIALS_PARAMETERS, VALUE, ERR, ERROR,) |
| Evaluate the analytic solution for a classical field equations set. More... | |
| subroutine, public | classical_field_control_loop_post_loop (CONTROL_LOOP, ERR, ERROR,) |
| Executes after each loop of a control loop for bioelectric problems, i.e., after each time step for a time loop. More... | |
| subroutine, public | classicalfield_equationssetspecificationset (equationsSet, specification, err, error,) |
| Sets the equations set specification for a classical field equation set. More... | |
| subroutine, public | classical_field_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,) |
| Calculates the element stiffness matries and rhs vector for the given element number for a clasical field class finite element equation set. More... | |
| subroutine, public | classicalfield_finiteelementjacobianevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,) |
| Evaluates the element Jacobian matrix for the given element number for a clasical field class finite element equation set. More... | |
| subroutine, public | classicalfield_finiteelementresidualevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,) |
| Evaluates the element residual and rhs vectors for the given element number for a clasical field class finite element equation set. More... | |
| subroutine, public | classical_field_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,) |
| Sets up the equations set for a classical field equations set class. More... | |
| subroutine, public | classicalfield_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,) |
| Sets/changes the solution method for a classical field equation set class. More... | |
| subroutine, public | classicalfield_boundaryconditionsanalyticcalculate (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,) |
| Sets the analytic boundary conditions for a classical field equation set class. More... | |
| subroutine, public | classicalfield_problemspecificationset (problem, problemSpecification, err, error,) |
| Sets the problem specification for a classical field problem class. More... | |
| subroutine, public | classical_field_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,) |
| Sets up the problem for a classical field problem class. More... | |
| subroutine, public | classical_field_pre_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,) |
| Sets up the output type for a classical field problem class. More... | |
| subroutine, public | classical_field_post_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,) |
| Sets up the output type for a classical field problem class. More... | |
This module handles all classical field class routines.
| subroutine, public classical_field_routines::classical_field_analytic_functions_evaluate | ( | type(equations_set_type), pointer | EQUATIONS_SET, |
| integer(intg), intent(in) | EQUATIONS_TYPE, | ||
| integer(intg), intent(in) | ANALYTIC_FUNCTION_TYPE, | ||
| real(dp), dimension(:), intent(in) | POSITION, | ||
| real(dp), dimension(:,:), intent(in) | TANGENTS, | ||
| real(dp), dimension(:), intent(in) | NORMAL, | ||
| real(dp), intent(in) | TIME, | ||
| integer(intg), intent(in) | VARIABLE_TYPE, | ||
| integer(intg), intent(in) | GLOBAL_DERIVATIVE, | ||
| integer(intg), intent(in) | COMPONENT_NUMBER, | ||
| real(dp), dimension(:), intent(in) | ANALYTIC_PARAMETERS, | ||
| real(dp), dimension(:), intent(in) | MATERIALS_PARAMETERS, | ||
| real(dp), intent(out) | VALUE, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Evaluate the analytic solution for a classical field equations set.
| equations_set | A pointer to the equations set to evaluate the analytic for | |
| [in] | equations_type | The type of equation to evaluate |
| [in] | analytic_function_type | The type of analytic function to evaluate |
| [in] | position | POSITION(dimention_idx). The geometric position to evaluate at |
| [in] | tangents | TANGENTS(dimention_idx,xi_idx). The geometric tangents at the point to evaluate at. |
| [in] | normal | NORMAL(dimension_idx). The normal vector at the point to evaluate at. |
| [in] | time | The time to evaluate at |
| [in] | variable_type | The field variable type to evaluate at |
| [in] | global_derivative | The global derivative direction to evaluate at |
| [in] | component_number | The dependent field component number to evaluate |
| [in] | analytic_parameters | A pointer to any analytic field parameters |
| [in] | materials_parameters | A pointer to any materials field parameters |
| [out] | value | On return, the analtyic function value. |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 108 of file classical_field_routines.f90.
References diffusion_equation_routines::diffusion_analyticfunctionsevaluate(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, and base_routines::exits().
Referenced by equations_set_routines::equations_set_analytic_functions_evaluate().
| subroutine, public classical_field_routines::classical_field_control_loop_post_loop | ( | type(control_loop_type), pointer | CONTROL_LOOP, |
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Executes after each loop of a control loop for bioelectric problems, i.e., after each time step for a time loop.
| control_loop | A pointer to the control loop to solve. | |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 175 of file classical_field_routines.f90.
References diffusion_equation_routines::diffusion_equation_control_loop_post_loop(), base_routines::enters(), base_routines::exits(), problem_constants::problem_control_time_loop_type, problem_constants::problem_diffusion_equation_type, and problem_constants::problem_reaction_diffusion_equation_type.
| subroutine, public classical_field_routines::classical_field_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 equations set for a classical field equations set class.
| equations_set | A pointer to the equations set | |
| [in,out] | equations_set_setup | The equations set setup information |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 469 of file classical_field_routines.f90.
References advection_equation_routines::advection_equationssetsetup(), advection_diffusion_equation_routines::advectiondiffusion_equationssetsetup(), diffusion_equation_routines::diffusion_equation_equations_set_setup(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::exits(), laplace_equations_routines::laplace_equation_equations_set_setup(), and poisson_equations_routines::poisson_equation_equations_set_setup().
Referenced by equations_set_routines::equations_set_setup().
| subroutine, public classical_field_routines::classical_field_finite_element_calculate | ( | type(equations_set_type), pointer | EQUATIONS_SET, |
| integer(intg), intent(in) | ELEMENT_NUMBER, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Calculates the element stiffness matries and rhs vector for the given element number for a clasical field class finite element equation set.
| equations_set | A pointer to the equations set | |
| [in] | element_number | The element number to calcualate |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 285 of file classical_field_routines.f90.
References advection_equation_routines::advection_equation_finite_element_calculate(), advection_diffusion_equation_routines::advectiondiffusion_finiteelementcalculate(), diffusion_equation_routines::diffusion_equation_finite_element_calculate(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::exits(), laplace_equations_routines::laplaceequation_finiteelementcalculate(), and poisson_equations_routines::poisson_equation_finite_element_calculate().
Referenced by equations_set_routines::equations_set_finite_element_calculate().
| subroutine, public classical_field_routines::classical_field_post_solve | ( | type(control_loop_type), pointer | CONTROL_LOOP, |
| type(solver_type), pointer | SOLVER, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Sets up the output type for a classical field problem class.
| control_loop | A pointer to the control loop to solve. | |
| solver | A pointer to the solver | |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 831 of file classical_field_routines.f90.
References advection_diffusion_equation_routines::advection_diffusion_post_solve(), diffusion_equation_routines::diffusion_equation_post_solve(), base_routines::enters(), base_routines::exits(), poisson_equations_routines::poisson_post_solve(), problem_constants::problem_advection_diffusion_equation_type, problem_constants::problem_advection_equation_type, problem_constants::problem_biharmonic_equation_type, problem_constants::problem_diffusion_equation_type, problem_constants::problem_helmholtz_equation_type, problem_constants::problem_hj_equation_type, problem_constants::problem_laplace_equation_type, problem_constants::problem_poisson_equation_type, problem_constants::problem_reaction_diffusion_equation_type, and problem_constants::problem_wave_equation_type.
| subroutine, public classical_field_routines::classical_field_pre_solve | ( | type(control_loop_type), pointer | CONTROL_LOOP, |
| type(solver_type), pointer | SOLVER, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Sets up the output type for a classical field problem class.
| control_loop | A pointer to the control loop to solve. | |
| solver | A pointer to the solver | |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 772 of file classical_field_routines.f90.
References advection_diffusion_equation_routines::advection_diffusion_pre_solve(), advection_equation_routines::advection_pre_solve(), diffusion_equation_routines::diffusion_equation_pre_solve(), base_routines::enters(), base_routines::exits(), poisson_equations_routines::poisson_pre_solve(), problem_constants::problem_advection_diffusion_equation_type, problem_constants::problem_advection_equation_type, problem_constants::problem_biharmonic_equation_type, problem_constants::problem_diffusion_equation_type, problem_constants::problem_helmholtz_equation_type, problem_constants::problem_hj_equation_type, problem_constants::problem_laplace_equation_type, problem_constants::problem_poisson_equation_type, problem_constants::problem_reaction_diffusion_equation_type, and problem_constants::problem_wave_equation_type.
| subroutine, public classical_field_routines::classical_field_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 problem for a classical field problem class.
| problem | A pointer to the problem | |
| [in,out] | problem_setup | The problem setup information |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 713 of file classical_field_routines.f90.
References advection_diffusion_equation_routines::advection_diffusion_equation_problem_setup(), advection_equation_routines::advection_equation_problem_setup(), diffusion_equation_routines::diffusion_equation_problem_setup(), base_routines::enters(), base_routines::exits(), laplace_equations_routines::laplace_equation_problem_setup(), poisson_equations_routines::poisson_equation_problem_setup(), problem_constants::problem_advection_diffusion_equation_type, problem_constants::problem_advection_equation_type, problem_constants::problem_biharmonic_equation_type, problem_constants::problem_diffusion_equation_type, problem_constants::problem_helmholtz_equation_type, problem_constants::problem_hj_equation_type, problem_constants::problem_laplace_equation_type, problem_constants::problem_poisson_equation_type, problem_constants::problem_reaction_diffusion_equation_type, and problem_constants::problem_wave_equation_type.
| subroutine, public classical_field_routines::classicalfield_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 | ||
| ) |
Sets the analytic boundary conditions for a classical field equation set class.
| equations_set | A pointer to the equations set to set the solution method for | |
| boundary_conditions | A pointer to the boundary conditionsn to set | |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 591 of file classical_field_routines.f90.
References advection_diffusion_equation_routines::advectiondiffusion_boundaryconditionsanalyticcalculate(), diffusion_equation_routines::diffusion_boundaryconditionanalyticcalculate(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::errors(), base_routines::exits(), laplace_equations_routines::laplace_boundaryconditionsanalyticcalculate(), and poisson_equations_routines::poisson_boundaryconditionsanalyticcalculate().
Referenced by equations_set_routines::equations_set_boundary_conditions_analytic().
| subroutine, public classical_field_routines::classicalfield_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 | ||
| ) |
Sets/changes the solution method for a classical field equation set class.
| equations_set | A pointer to the equations set to set the solution method for | |
| [in] | solution_method | The solution method to set |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 529 of file classical_field_routines.f90.
References advection_equation_routines::advection_equationssetsolutionmethodset(), advection_diffusion_equation_routines::advectiondiffusion_equationssetsolnmethodset(), diffusion_equation_routines::diffusion_equationssetsolutionmethodset(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::errors(), base_routines::exits(), laplace_equations_routines::laplace_equationssetsolutionmethodset(), and poisson_equations_routines::poisson_equationssetsolutionmethodset().
Referenced by equations_set_routines::equations_set_solution_method_set().
| subroutine, public classical_field_routines::classicalfield_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 equations set specification for a classical field equation set.
| equationsset | A pointer to the equations set | |
| [in] | specification | The equations specification to set |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 225 of file classical_field_routines.f90.
References advection_equation_routines::advection_equationssetspecificationset(), advection_diffusion_equation_routines::advectiondiffusion_equationssetspecificationset(), diffusion_equation_routines::diffusion_equationssetspecificationset(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::errors(), base_routines::exits(), laplace_equations_routines::laplace_equationssetspecificationset(), and poisson_equations_routines::poisson_equationssetspecificationset().
Referenced by equations_set_routines::equationsset_specificationset().
| subroutine, public classical_field_routines::classicalfield_finiteelementjacobianevaluate | ( | type(equations_set_type), pointer | EQUATIONS_SET, |
| integer(intg), intent(in) | ELEMENT_NUMBER, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Evaluates the element Jacobian matrix for the given element number for a clasical field class finite element equation set.
| equations_set | A pointer to the equations set | |
| [in] | element_number | The element number to evaluate the Jacobian for |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 345 of file classical_field_routines.f90.
References diffusion_equation_routines::diffusion_finiteelementjacobianevaluate(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::errors(), base_routines::exits(), and poisson_equations_routines::poisson_finiteelementjacobianevaluate().
Referenced by equations_set_routines::equationsset_finiteelementjacobianevaluate().
| subroutine, public classical_field_routines::classicalfield_finiteelementresidualevaluate | ( | type(equations_set_type), pointer | EQUATIONS_SET, |
| integer(intg), intent(in) | ELEMENT_NUMBER, | ||
| integer(intg), intent(out) | ERR, | ||
| type(varying_string), intent(out) | ERROR | ||
| ) |
Evaluates the element residual and rhs vectors for the given element number for a clasical field class finite element equation set.
| equations_set | A pointer to the equations set | |
| [in] | element_number | The element number to evaluate the residual for |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 407 of file classical_field_routines.f90.
References advection_equation_routines::advection_equation_finite_element_calculate(), diffusion_equation_routines::diffusion_finiteelementresidualevaluate(), base_routines::enters(), equations_set_constants::equations_set_advection_diffusion_equation_type, equations_set_constants::equations_set_advection_equation_type, equations_set_constants::equations_set_biharmonic_equation_type, equations_set_constants::equations_set_diffusion_equation_type, equations_set_constants::equations_set_helmholtz_equation_type, equations_set_constants::equations_set_hj_equation_type, equations_set_constants::equations_set_laplace_equation_type, equations_set_constants::equations_set_poisson_equation_type, equations_set_constants::equations_set_reaction_diffusion_equation_type, equations_set_constants::equations_set_wave_equation_type, base_routines::errors(), base_routines::exits(), and poisson_equations_routines::poisson_finiteelementresidualevaluate().
Referenced by equations_set_routines::equationsset_finiteelementresidualevaluate().
| subroutine, public classical_field_routines::classicalfield_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 classical field problem class.
| problem | A pointer to the problem to set the specification for. | |
| [in] | problemspecification | The problem specification to set. |
| [out] | err | The error code |
| [out] | error | The error string |
Definition at line 651 of file classical_field_routines.f90.
References advection_equation_routines::advection_problemspecificationset(), advection_diffusion_equation_routines::advectiondiffusion_problemspecificationset(), diffusion_equation_routines::diffusion_problemspecificationset(), base_routines::enters(), base_routines::errors(), base_routines::exits(), laplace_equations_routines::laplace_problemspecificationset(), poisson_equations_routines::poisson_problemspecificationset(), problem_constants::problem_advection_diffusion_equation_type, problem_constants::problem_advection_equation_type, problem_constants::problem_biharmonic_equation_type, problem_constants::problem_diffusion_equation_type, problem_constants::problem_helmholtz_equation_type, problem_constants::problem_hj_equation_type, problem_constants::problem_laplace_equation_type, problem_constants::problem_poisson_equation_type, problem_constants::problem_reaction_diffusion_equation_type, and problem_constants::problem_wave_equation_type.
1.8.11