The Nek5000 core library

Functions/Subroutines
program	nekton
	Drives the solver calling 3 subroutines: More...
subroutine	nek_init (intracomm)
	Initializes the solver and variables. More...
subroutine	nek_solve
	Runs post processing or time advancment based on value of instep. Parent subroutine to nek__multi_advance() which calls nek_advance() once. Also handles: More...
subroutine	nek_advance
	Time advancement. What it does differs based on solver flags and formulation. Summary of calls: More...
subroutine	nek_end
	Complete simulation. More...
subroutine	nek__multi_advance (kstep, msteps)
	Multi-level time advancement. Calls nek_advance() msteps times. More...
subroutine	fluid (igeom)
	Driver for solving the incompressible Navier-Stokes equations. More...
subroutine	incomprn (ux, uy, uz, up)
	Project U onto the closest incompressible field. More...
subroutine	makef
	Compute and add. More...
subroutine	plan3 (IGEOM)
	Compute pressure and velocity using consistent approximation spaces. Operator splitting technique. More...

Detailed Description

Function/Subroutine Documentation

fluid()

subroutine fluid

(

igeom

)

Driver for solving the incompressible Navier-Stokes equations.

Here is the call graph for this function:

incomprn()

subroutine incomprn	(		ux,
			uy,
			uz,
			up
	)

Project U onto the closest incompressible field.

Here is the call graph for this function:

makef()

subroutine makef

(

)

Compute and add.

1. user specified forcing function (FX,FY,FZ)
2. driving force due to natural convection
3. convection term

Here is the call graph for this function:

nek__multi_advance()

subroutine nek__multi_advance	(		kstep,
			msteps
	)

Multi-level time advancement. Calls nek_advance() msteps times.

nek_advance()

subroutine nek_advance

(

)

Time advancement. What it does differs based on solver flags and formulation. Summary of calls:

• userchk_set_xfer()
• fluid(), heat()
• q_filter() with param(103)

Here is the call graph for this function:

nek_end()

subroutine nek_end

(

)

Complete simulation.

• If zero steps, call runstat() which profiles different components
• Gather scatter library stats: fgslib_crs_stats(xxth(1))
• Finally, in_situ_end() shuts down VisIt with visit_end()

Here is the call graph for this function:

nek_init()

subroutine nek_init

(

intracomm

)

Initializes the solver and variables.

Calls the following subroutines in order:

• iniparser: ?
• Session get_session_info(), dnekclock(), opcount() <- 1
• Grid: initdim(), initdat(), files(), dnekclock(), readat()
• Sync: dnekclock_sync(): mpi_barrier() and mpi_wtime()
• Initialize variables: setvar()
• Mesh: setup_topo(), genwz(), usrdat()
• Geometry: gengeom()
• Setup Direct Stiffness Summation (DSS): setup_mesh_dssum(), usrdat2(), geom_reset()
• Verify: vrdsmsh()
• Optionals run if the flags are set
  • dg: dg_setup()
  • ifflow: estrat(). iftran set_overlap()
  • ifcvode: False?
• usrdat3()
• Initial conditions: setics(), setprop()
• User check: ifneknek: False. userchk(): calculates eddy viscosity
• Misc functions: comment(), sstest(), dofcnt(), in_situ_init(), time00(), opcount() <- 2

Here is the call graph for this function:

nek_solve()

subroutine nek_solve

(

)

Runs post processing or time advancment based on value of instep. Parent subroutine to nek__multi_advance() which calls nek_advance() once. Also handles:

• Set flag ::ifoutfld via set_outfld()
• Runs userchk() (for example, eddy viscosity)
• Calls prepost()

start measurements

check for post-processing mode

Here is the call graph for this function:

nekton()

program nekton

(

)

Drives the solver calling 3 subroutines:

• nek_init()
• nek_solve()
• nek_end()
• exitt0()

plan3()

subroutine plan3

(

IGEOM

)

Compute pressure and velocity using consistent approximation spaces. Operator splitting technique.

Here is the call graph for this function: