symmetry Module Reference

Implements symmetry_t.

Data Types
type	symmetry_t
	Symmetry boundary condition constraining the normal vector component. More...

Functions/Subroutines
subroutine	symmetry_init (this, coef, json)
	Construct the boundary condition from JSON.
subroutine	symmetry_init_from_components (this, coef)
	Construct the boundary condition from its components.
subroutine	symmetry_finalize (this)
	Finalize the boundary condition.
subroutine	symmetry_apply_scalar (this, x, n, time, strong)
	No-op scalar application.
subroutine	symmetry_apply_vector (this, x, y, z, n, time, strong)
	Remove the normal component on the CPU.
subroutine	symmetry_apply_scalar_dev (this, x_d, time, strong, strm)
	No-op scalar application on the device.
subroutine	symmetry_apply_vector_dev (this, x_d, y_d, z_d, time, strong, strm)
	Remove the normal component on the device.
subroutine	symmetry_free (this)
	Free the boundary condition and its mixed-bc storage.

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, type(time_state_t), intent(in), optional  time, logical, intent(in), optional  strong  )

private

Parameters

x	Scalar field values.
n	Number of entries in x.
time	Current time state.
strong	Whether to apply the strong form.

Definition at line 111 of file symmetry.f90.

symmetry_apply_scalar_dev()

subroutine symmetry::symmetry_apply_scalar_dev ( class(symmetry_t), intent(inout), target  this, type(c_ptr), intent(inout)  x_d, type(time_state_t), intent(in), optional  time, logical, intent(in), optional  strong, type(c_ptr), intent(inout)  strm  )

private

Parameters

x_d	Device pointer to the scalar field.
time	Current time state.
strong	Whether to apply the strong form.
strm	Device stream.

Definition at line 166 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, type(time_state_t), intent(in), optional  time, logical, intent(in), optional  strong  )

private

Uses the resolved mixed-node mask together with the local normal vector provided by the coupled vector BC projector.

Parameters

x	x-component of the field.
y	y-component of the field.
z	z-component of the field.
n	Number of entries in each component array.
time	Current time state.
strong	Whether to apply the strong form.

Definition at line 128 of file symmetry.f90.

symmetry_apply_vector_dev()

subroutine symmetry::symmetry_apply_vector_dev ( class(symmetry_t), intent(inout), target  this, type(c_ptr), intent(inout)  x_d, type(c_ptr), intent(inout)  y_d, type(c_ptr), intent(inout)  z_d, type(time_state_t), intent(in), optional  time, logical, intent(in), optional  strong, type(c_ptr), intent(inout)  strm  )

private

Uses the resolved mixed-node mask together with the local basis vectors provided by the coupled vector BC projector.

Parameters

x_d	Device pointer to the x-component.
y_d	Device pointer to the y-component.
z_d	Device pointer to the z-component.
time	Current time state.
strong	Whether to apply the strong form.
strm	Device stream.

Definition at line 183 of file symmetry.f90.

Here is the call graph for this function:

symmetry_finalize()

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

private

Definition at line 97 of file symmetry.f90.

symmetry_free()

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

private

Definition at line 211 of file symmetry.f90.

symmetry_init()

subroutine symmetry::symmetry_init	(	class(symmetry_t), intent(inout), target	this,
		type(coef_t), intent(in), target	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 76 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), target  coef  )

private

Parameters

[in]

coef

The SEM coefficients.

Definition at line 86 of file symmetry.f90.