symmetry Module Reference

Mixed Dirichlet-Neumann axis aligned symmetry plane.

Data Types
type	symmetry_t
	Mixed Dirichlet-Neumann symmetry plane condition. More...

Functions/Subroutines
subroutine	symmetry_init (this, coef, json)
	Constructor.
subroutine	symmetry_init_from_components (this, coef)
	Constructor from components.
subroutine	symmetry_finalize (this)
	Finalize. Marks the appropriate faces for application of a homogeneous Dirchlet condition based on the direction of the axis normal.
subroutine	symmetry_get_normal_axis (this, sx, sy, sz, facet, el)
	Compute the average normal for a facet of an element.
subroutine	symmetry_apply_scalar (this, x, n, t, tstep, strong)
	No-op scalar apply.
subroutine	symmetry_apply_vector (this, x, y, z, n, t, tstep, strong)
	Apply symmetry conditions (axis aligned)
subroutine	symmetry_apply_scalar_dev (this, x_d, t, tstep, strong)
	No-op scalar apply (device version)
subroutine	symmetry_apply_vector_dev (this, x_d, y_d, z_d, t, tstep, strong)
	Apply symmetry conditions (axis aligned) (device version)
subroutine	symmetry_free (this)
	Destructor.

Function/Subroutine Documentation

symmetry_apply_scalar()

subroutine symmetry::symmetry_apply_scalar ( class(symmetry_t), intent(inout)  this, real(kind=rp), dimension(n), intent(inout)  x, integer, intent(in)  n, real(kind=rp), intent(in), optional  t, integer, intent(in), optional  tstep, logical, intent(in), optional  strong  )

private

Parameters

x	The field for which to apply the boundary condition.
n	The size of x.
t	Current time.
tstep	Current time-step.
strong	Whether we are setting a strong or a weak bc.

Definition at line 198 of file symmetry.f90.

symmetry_apply_scalar_dev()

subroutine symmetry::symmetry_apply_scalar_dev ( class(symmetry_t), intent(inout), target  this, type(c_ptr)  x_d, real(kind=rp), intent(in), optional  t, integer, intent(in), optional  tstep, logical, intent(in), optional  strong  )

private

Parameters

x_d	Device pointer to the field.
t	The time value.
tstep	The time iteration.
strong	Whether we are setting a strong or a weak bc.

Definition at line 241 of file symmetry.f90.

symmetry_apply_vector()

subroutine symmetry::symmetry_apply_vector ( class(symmetry_t), intent(inout)  this, real(kind=rp), dimension(n), intent(inout)  x, real(kind=rp), dimension(n), intent(inout)  y, real(kind=rp), dimension(n), intent(inout)  z, integer, intent(in)  n, real(kind=rp), intent(in), optional  t, integer, intent(in), optional  tstep, logical, intent(in), optional  strong  )

private

Parameters

x	The x comp of the field for which to apply the bc.
y	The y comp of the field for which to apply the bc.
z	The z comp of the field for which to apply the bc.
n	The size of x, y, and z.
t	Current time.
tstep	Current time-step.
strong	Whether we are setting a strong or a weak bc.

Definition at line 215 of file symmetry.f90.

symmetry_apply_vector_dev()

subroutine symmetry::symmetry_apply_vector_dev ( class(symmetry_t), intent(inout), target  this, type(c_ptr)  x_d, type(c_ptr)  y_d, type(c_ptr)  z_d, real(kind=rp), intent(in), optional  t, integer, intent(in), optional  tstep, logical, intent(in), optional  strong  )

private

Parameters

x_d	Device pointer to the values to be applied for the x comp.
y_d	Device pointer to the values to be applied for the y comp.
z_d	Device pointer to the values to be applied for the z comp.
t	The time value.
tstep	Current time-step.
strong	Whether we are setting a strong or a weak bc.

Definition at line 256 of file symmetry.f90.

symmetry_finalize()

subroutine symmetry::symmetry_finalize ( class(symmetry_t), intent(inout), target  this )

private

Definition at line 103 of file symmetry.f90.

symmetry_free()

subroutine symmetry::symmetry_free ( class(symmetry_t), intent(inout), target  this )

private

Definition at line 276 of file symmetry.f90.

symmetry_get_normal_axis()

subroutine symmetry::symmetry_get_normal_axis ( class(symmetry_t), intent(inout), target  this, real(kind=rp), intent(out)  sx, real(kind=rp), intent(out)  sy, real(kind=rp), intent(out)  sz, integer, intent(in)  facet, integer, intent(in)  el  )

private

The normal direction is the one for which s is 0, so e.g for a y normal, sx and sz will be unity, and sy will be 0.

Definition at line 144 of file symmetry.f90.

symmetry_init()

subroutine symmetry::symmetry_init	(	class(symmetry_t), intent(inout), target	this,
		type(coef_t), intent(in)	coef,
		type(json_file), intent(inout)	json
	)

Parameters

[in]	coef	The SEM coefficients.
[in,out]	json	The JSON object configuring the boundary condition.

Definition at line 75 of file symmetry.f90.

symmetry_init_from_components()

subroutine symmetry::symmetry_init_from_components ( class(symmetry_t), intent(inout), target  this, type(coef_t), intent(in)  coef  )

private

Parameters

[in]

coef

The SEM coefficients.

Definition at line 86 of file symmetry.f90.