OpenCMISS-Iron Internal API Documentation
fluid_mechanics_routines Module Reference

This module handles all fluid mechanics class routines. More...

Functions/Subroutines

subroutine, public fluid_mechanics_analytic_functions_evaluate (EQUATIONS_SET, 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 fluid mechanics equations set. More...
 
subroutine, public fluidmechanics_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the problem specification for a fluid mechanics equation set class. More...
 
subroutine, public fluid_mechanics_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Calculates the element stiffness matries and rhs vector for the given element number for a fluid mechanics class finite element equation set. More...
 
subroutine, public fluidmechanics_finiteelementjacobianevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Evaluates the element Jacobian matrix for the given element number for a fluid mechanics class finite element equation set. More...
 
subroutine, public fluidmechanics_finiteelementresidualevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Evaluates the element residual and rhs vectors for the given element number for a fluid mechanics class finite element equation set. More...
 
subroutine, public fluidmechanics_nodaljacobianevaluate (equationsSet, nodeNumber, err, error,)
 Evaluates the nodal Jacobian matrix for the given node number for a fluid mechanics class nodal equation set. More...
 
subroutine, public fluidmechanics_nodalresidualevaluate (equationsSet, nodeNumber, err, error,)
 Evaluates the nodal residual and rhs vectors for the given node number for a fluid mechanics class nodal equation set. More...
 
subroutine, public fluid_mechanics_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the equations set for a fluid mechanics equations set class. More...
 
subroutine, public fluidmechanics_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Sets/changes the solution method for a fluid mechanics equation set class. More...
 
subroutine, public fluidmechanics_boundaryconditionsanalyticcalculate (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
 Sets the analytic boundary conditions for a fluid mechanics equation set class. More...
 
subroutine, public fluidmechanics_problemspecificationset (problem, problemSpecification, err, error,)
 Sets the problem specification for a fluid mechanics problem class. More...
 
subroutine, public fluid_mechanics_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the problem for a fluid mechanics problem class. More...
 
subroutine, public fluid_mechanics_post_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the output type for a fluid mechanics problem class. More...
 
subroutine, public fluid_mechanics_pre_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the output type for a fluid mechanics problem class. More...
 
subroutine, public fluid_mechanics_control_loop_pre_loop (CONTROL_LOOP, ERR, ERROR,)
 Executes before each loop of a control loop, ie before each time step for a time loop. More...
 
subroutine, public fluid_mechanics_control_loop_post_loop (CONTROL_LOOP, ERR, ERROR,)
 Executes after each loop of a control loop, ie after each time step for a time loop. More...
 
subroutine, public fluidmechanics_finiteelementpreresidualevaluate (equationsSet, err, error,)
 Pre-residual steps for an fluid mechanics class finite element equation set. More...
 

Detailed Description

This module handles all fluid mechanics class routines.

Function/Subroutine Documentation

subroutine, public fluid_mechanics_routines::fluid_mechanics_analytic_functions_evaluate ( type(equations_set_type), pointer  EQUATIONS_SET,
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 fluid mechanics equations set.

Parameters
equations_setA pointer to the equations set to evaluate the analytic for
[in]analytic_function_typeThe type of analytic function to evaluate
[in]positionPOSITION(dimention_idx). The geometric position to evaluate at
[in]tangentsTANGENTS(dimention_idx,xi_idx). The geometric tangents at the point to evaluate at.
[in]normalNORMAL(dimension_idx). The normal vector at the point to evaluate at.
[in]timeThe time to evaluate at
[in]variable_typeThe field variable type to evaluate at
[in]global_derivativeThe global derivative direction to evaluate at
[in]component_numberThe dependent field component number to evaluate
[in]analytic_parametersA pointer to any analytic field parameters
[in]materials_parametersA pointer to any materials field parameters
[out]valueOn return, the analtyic function value.
[out]errThe error code
[out]errorThe error string

Definition at line 121 of file fluid_mechanics_routines.f90.

References burgers_equation_routines::burgers_analyticfunctionsevaluate(), base_routines::enters(), equations_set_constants::equations_set_burgers_equation_type, equations_set_constants::equations_set_characteristic_equation_type, equations_set_constants::equations_set_darcy_equation_type, equations_set_constants::equations_set_darcy_pressure_equation_type, equations_set_constants::equations_set_navier_stokes_equation_type, equations_set_constants::equations_set_poiseuille_equation_type, equations_set_constants::equations_set_stokes_equation_type, and base_routines::exits().

subroutine, public fluid_mechanics_routines::fluid_mechanics_control_loop_post_loop ( type(control_loop_type), pointer  CONTROL_LOOP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_control_loop_pre_loop ( type(control_loop_type), pointer  CONTROL_LOOP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_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 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_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 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_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 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_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 
)
subroutine, public fluid_mechanics_routines::fluid_mechanics_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 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_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 fluid_mechanics_routines::fluidmechanics_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 fluid_mechanics_routines::fluidmechanics_equationssetspecificationset ( type(equations_set_type), pointer  equationsSet,
integer(intg), dimension(:), intent(in)  specification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_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 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_finiteelementpreresidualevaluate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_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 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_nodaljacobianevaluate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  nodeNumber,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_nodalresidualevaluate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  nodeNumber,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public fluid_mechanics_routines::fluidmechanics_problemspecificationset ( type(problem_type), pointer  problem,
integer(intg), dimension(:), intent(in)  problemSpecification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)