initial_conditions.f90 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	user_initial_conditions::scalar_z_split_ic (s, split_value, value_below, value_above)
	Set the initial condition for the scalar field.

Detailed Description

Copyright

Copyright (c) 2023-2025, The Neko-TOP Authors All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file initial_conditions.f90.

Function/Subroutine Documentation

scalar_z_split_ic()

subroutine user_initial_conditions::scalar_z_split_ic	(	type(field_t), intent(inout)	s,
		real(kind=rp), intent(in)	split_value,
		real(kind=rp), intent(in)	value_below,
		real(kind=rp), intent(in)	value_above
	)

This function will initialize the scalar field with a two part uniform value. Above z=z0 the scalar field will be 0.0 and below z=z0 the scalar field will be 1.0. z0 is read from the JSON file under the key 'case.scalar.initial_condition.value' or set to 0.0 if not found.

Parameters

[in,out]	s	Scalar field
[in]	split_value
[in]	value_below	Value assigned below the split value
[in]	value_above	Value assigned above the split value

Definition at line 56 of file initial_conditions.f90.